Repository navigation
docs: use current set-track, init, and track-promotion guidance - #715
Conversation
AbhishekDoshi26
left a comment
There was a problem hiding this comment.
Fresh review at 1736786 found nothing to fix.
- CLI (v1.6.128): the
set-trackandinitoptions are namedrelease-version,patch-numberandorg-id. The old names arealiases:, which--helpdoesn't show.promotesetshidden => trueand still runs without--json, so "existing scripts still work" is true.set-track --track stablenever prompts, becausestablealways exists. - Console: Change Track maps over every track from
getChannels, and is shown whenevercanChangeTrackis true. That's any patch on a track with artifacts, and since #3130 it doesn't depend on whether a newer patch replaced it. This is live in the 2026-10-11 prod deploy. - Coverage: no
set-track --release/--patch,--organization-id,patches promoteexample, or "Console only promotes to stable" claim is left insrc/,public/orastro.config.mjs. Linked anchors are unchanged. - Build: 0 errors in
astro check, all internal links valid, CI green.
Note: the new flag names only exist in 1.6.128 and later. Users on older CLIs who copy these examples should run shorebird upgrade first.
AbhishekDoshi26
left a comment
There was a problem hiding this comment.
Re-review at 9afef66 found two small issues. Both are fixed in bf00cde:
patch.mdx: the "Promote a patch" example came before the version note, which sits in "Set patch track" because #679 links there. A one-line pointer after the example now links to that note.- PR description: it listed
scripting.mdxamong the pages with a version note. That page only mentions--org-idin prose, and the CLI's own error hint names the right flag for each version, so it gets no note. The description now says so.
AbhishekDoshi26
left a comment
There was a problem hiding this comment.
Fresh review at bf00cde found nothing to fix. All four version notes follow the rollback.mdx wording, and the patch.mdx pointer resolves to #set-patch-track on the rendered page. The description matches the diff, and the scripting.mdx edit is still clear of #714's hunks. No old flag names, promote examples, or "stable only" claims are left in src/, public/ or astro.config.mjs. Build: 0 errors in astro check, all internal links valid, CI green.
Dependencies
None; this can merge on its own. It touches one line of
code-push/ci/scripting.mdx(line 35), away from the lines #714 edits, so the two merge cleanly in either order.Description
Updates the docs to match Shorebird CLI 1.6.128 and the current Console.
Flag renames (shorebirdtech/shorebird#4045, CLI 1.6.128):
shorebird patches set-tracknow takes--release-versionand--patch-number, matching the otherpatchescommands.shorebird initnow takes--org-id, likeapps transfer.The old names,
--release,--patch, and--organization-id, still work as hidden aliases, but--helpno longer shows them. Every example now uses the new names. Because the new names don't exist before 1.6.128, each page with these examples also says they need Shorebird 1.6.128 or newer, and that older CLIs should use the old names or runshorebird upgradefirst. This matches the wordingrollback.mdxalready uses. The pages are:code-push/tracks.mdxcode-push/initialize.mdxcode-push/patch.mdx: the note is in "Set patch track", and the "Promote a patch" example points to it.code-push/guides/staging-patches.mdxcode-push/ci/scripting.mdxalso switches to--org-id. It only mentions the flag in prose, so it gets no version note: the CLI's own error hint names the right flag for each version.shorebird patches promoteis deprecated: at 1.6.128 it is hidden from help, refuses--json, and tells users to runset-track --track=stableinstead.tracks.mdxandpatch.mdxnow promote withshorebird patches set-track --track stable.tracks.mdxsayspromoteis deprecated and that existing scripts still work.The Console can move a patch to any track:
tracks.mdxsaid the Console only promotes tostable. That was wrong. The Change Track dialog lists every track in the app (patch-action-menu.tsx, since_shorebird#2192 in May). The Console section and the FAQ answer now say so.The
#via-the-shorebird-console,#promote-a-patch, and#set-patch-trackheadings are unchanged. #679 links to the first, and its changelog entries link to the last.Test plan
promotebehavior checked againstcommon_arguments.dart,set_track_command.dart,promote_command.dart, andinit_command.dartatv1.6.128set-trackwas addedpatch-action-menu.tsxon_shorebirdmain