docs: document the Roll Forward patch action - #670
Conversation
The console exposes a "Roll Forward" action on rolled back patches, but rollback.mdx never mentioned it, so the docs read as though a rollback were one-way. - Add a "Roll a patch forward" section covering where the action lives, that it only appears on a currently rolled back patch, and what happens on device when a patch is rolled forward. - Note that re-downloading the patch counts against monthly patch installs, matching the existing caveat for rollback. - Explain that releases on Flutter versions without rollback support get Deactivate instead, how that differs on device, and that it is undone by moving the patch back to the stable track rather than by rolling forward. - Mention in the intro that a rollback is reversible.
The updater downloads in the background and applies on the next restart, per "When do updates happen?"; say that rather than "install it the next time the app starts". Also drop the claim that a never-rolled-back patch shows "Rollback", which is only true on releases that support rollback at all.
Self-reviewRe-read this against the console source and the rest of the docs. Two wording fixes pushed in 996608e, plus one correction I had already made before opening the PR. Fixed: update timing did not match our own FAQI wrote that devices "pick it up on their next patch check and install it the next time the app starts." Per "When do updates happen?", the updater checks on startup, downloads in the background during that session, and applies the patch on the next restart. Now worded as download on the next check, apply on the next restart, so the two pages agree. Fixed: overstated when Rollback appears"A patch that has never been rolled back shows Rollback instead" is only true on releases that support rollback at all. On releases that do not, the menu offers Deactivate and neither Rollback nor Roll Forward appears. Reworded to say the same menu offers Rollback on a patch that is not rolled back, which is true in the context where Roll Forward is relevant. Corrected before opening: deactivation is reversibleMy first draft said deactivation could not be undone and that you would have to publish a new patch. That is wrong. Deactivate promotes the patch to a Verified
Still open for you
|
ef28dbc to
09aab36
Compare
dawn-ducky
left a comment
There was a problem hiding this comment.
Changes and questions for clarity
- Mention roll forward in the page description - Drop wording implying rollbacks count against patch installs - State the Flutter versions that lack rollback (3.22.2 and earlier) and correct the minimum version note to 3.22.3
… Forward Rollback support is not cleanly bounded by a Flutter version (early 3.22.3 builds predate it), so restore the original minimum version note and remove the section describing unsupported releases.
Why
The console has a Roll Forward action on rolled back patches, but
rollback.mdxnever mentioned it. The docs read as though rolling back were aone-way door, which is the opposite of the point we make elsewhere when we tell
users to roll back rather than delete a release.
What changed
All in
rollback.mdx:stabletrack rather than by rolling forward.src/assets/roll_forward_button.png), matching the existing screenshot for the Rollback action.Verification
prettier,cspell, andvaleclean;astro buildpasses with "All internallinks are valid", including the new
#roll-a-patch-forwardanchor.