Add changelog for wrangler deploy's better config conflict management
#26401
Conversation
dario-piotrowicz
force-pushed
the
dario/DEVX-2112/better-config-management-changelog
branch
from
6a28770 to
cd69648
Compare
dario-piotrowicz
force-pushed
the
dario/DEVX-2112/better-config-management-changelog
branch
from
cd69648 to
667a60a
Compare
src/content/changelog/workers/2025-11-xx-wrangler-deploy-remote-config-management.mdx
Outdated
Show resolved
Hide resolved
src/content/changelog/workers/2025-11-xx-wrangler-deploy-remote-config-management.mdx
Outdated
Show resolved
Hide resolved
src/content/changelog/workers/2025-11-xx-wrangler-deploy-remote-config-management.mdx
Outdated
Show resolved
Hide resolved
src/content/changelog/workers/2025-11-xx-wrangler-deploy-remote-config-management.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: lrapoport-cf <[email protected]>
Co-authored-by: lrapoport-cf <[email protected]>
Co-authored-by: lrapoport-cf <[email protected]>
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
src/content/changelog/workers/2025-11-13-wrangler-deploy-remote-config-management.mdx
Outdated
Show resolved
Hide resolved
|
@dario-piotrowicz noted one more small fix but otherwise lgtm! |
…e-config-management.mdx Co-authored-by: lrapoport-cf <[email protected]>
irvinebroque
left a comment
irvinebroque
left a comment
There was a problem hiding this comment.
This is a great change!
Can we show rather than just tell though?
ex: show example that shows before vs. after, Wrangler's output?
Thanks 😄
Sure, I was trying to be concise and I was afraid that adding an example could be a bit too much here Do you have anything specific in mind? Do you think a screenshot could be appropriate here? |
|
Same feedback as Brendan - I think a gif or an image would be great. - Maybe an image of the moment before you confirm a change? I also think we can probably make this benefit more clear -> "No accidental overrides of changes from the Dashboard". - Will drop some inline suggestions |
| @@ -0,0 +1,15 @@ | |||
| --- | |||
| title: Wrangler deploy - Better remote configuration conflict management | |||
There was a problem hiding this comment.
What about just: "Workers CLI deployments don't automatically override UI-driven updates"
More direct?
There was a problem hiding this comment.
And "Workers CLI" because this is full Cloudflare changelog, so we should say Workers somewhere**
There was a problem hiding this comment.
The fact is that wrangler already does that, but in a simpler way, so your wording might make it sound like this is a new behavior we're introducing? 🤔 (instead of it being an improvement on an existing behavior)
| --- | ||
|
|
||
| Until now, if a Worker had been previously deployed via the [Cloudflare Dashboard](https://dash.cloudflare.com), subsequent | ||
| [`wrangler deploy`](https://developers.cloudflare.com/workers/wrangler/commands/#deploy) invocations would require the user to forcefully override the remote worker settings. |
There was a problem hiding this comment.
"would require the user to forcefully override the remote worker settings" - I don't immediately understand what this means.
Would just saying this be better:
"
Previously, if a Worker had been updated and deployed via the Cloudflare Dashboard, a user might deploy via the CLI and accidentally override values set in the dashboard. So users would have to manually update Wrangler config after the dashboard change was made.
"
There was a problem hiding this comment.
and accidentally override values set in the dashboard
But wrangler currently does stop users from deploying in this case, asking them if they are sure if they want to proceed and override the remove values (the difference being that before no information about this override would was presented to the user and now wrangler will instead show the diff), so I think that it's quite unlikely that they would accidentally override the values? 🤔
| [`wrangler deploy`](https://developers.cloudflare.com/workers/wrangler/commands/#deploy) invocations would require the user to forcefully override the remote worker settings. | ||
|
|
||
| Now instead, `wrangler deploy` presents a helpful representation of the differences between the | ||
| [local configuration](https://developers.cloudflare.com/workers/wrangler/configuration/) and the remote settings, and offers to update your local configuration file for you. If instead Wrangler detects that a deployment won't modify or remove settings updated from the Dashboard, it will simply proceed with deployment without requesting any user interaction. |
There was a problem hiding this comment.
"If instead Wrangler detects that a deployment won't modify or remove settings updated from the Dashboard, it will simply proceed with deployment without requesting any user interaction."
I might just cut this part completely or cut it down to:
"If you have not made any updates remotely, a wrangler deploy will run as usual."
There was a problem hiding this comment.
"If you have not made any updates remotely, a
wrangler deploywill run as usual."
But that would completely remove a nice improvement made here, the fact that wrangler deploy will successfully deploy if the user has made updates in the dash, as long as those updates are not going to be removed/modified by the deployment
isn't this something valuable to bring up?
8 participants
wrangler deployhas been improved to check for workers previously deployed via the dashboard and provide a better UX where users are presented with a representation of the difference between local and remote configs alongside other similar improvements, this PR adds a changelog entry for such improvementNote
This PR should not be merged until the changes in cloudflare/workers-sdk#11229 are merged and released