Skip to content

docs: use current set-track, init, and track-promotion guidance - #715

Merged
AbhishekDoshi26 merged 7 commits into
mainfrom
docs/new-flag-names
Oct 12, 2026
Merged

AbhishekDoshi26 merged 7 commits into
mainfrom
docs/new-flag-names

Conversation

@AbhishekDoshi26

@AbhishekDoshi26 AbhishekDoshi26 commented Oct 12, 2026 •

Copy link
Copy Markdown
Member

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-track now takes --release-version and --patch-number, matching the other patches commands.
  • shorebird init now takes --org-id, like apps transfer.

The old names, --release, --patch, and --organization-id, still work as hidden aliases, but --help no 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 run shorebird upgrade first. This matches the wording rollback.mdx already uses. The pages are:

  • code-push/tracks.mdx
  • code-push/initialize.mdx
  • code-push/patch.mdx: the note is in "Set patch track", and the "Promote a patch" example points to it.
  • code-push/guides/staging-patches.mdx

code-push/ci/scripting.mdx also 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 promote is deprecated: at 1.6.128 it is hidden from help, refuses --json, and tells users to run set-track --track=stable instead.

  • tracks.mdx and patch.mdx now promote with shorebird patches set-track --track stable.
  • The note in tracks.mdx says promote is deprecated and that existing scripts still work.

The Console can move a patch to any track: tracks.mdx said the Console only promotes to stable. 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-track headings are unchanged. #679 links to the first, and its changelog entries link to the last.

Test plan

  • Flag names and promote behavior checked against common_arguments.dart, set_track_command.dart, promote_command.dart, and init_command.dart at v1.6.128
  • Old names checked at v1.6.127, v1.6.100 and v1.6.80, so the "older CLI" advice holds back to when set-track was added
  • Console behavior checked against patch-action-menu.tsx on _shorebird main
  • Prettier passes on all changed files

@AbhishekDoshi26 AbhishekDoshi26 changed the title docs: use the 1.6.128 flag names for set-track and init docs: use current set-track, init, and track-promotion guidance Oct 12, 2026

@AbhishekDoshi26 AbhishekDoshi26 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fresh review at 1736786 found nothing to fix.

  • CLI (v1.6.128): the set-track and init options are named release-version, patch-number and org-id. The old names are aliases:, which --help doesn't show. promote sets hidden => true and still runs without --json, so "existing scripts still work" is true. set-track --track stable never prompts, because stable always exists.
  • Console: Change Track maps over every track from getChannels, and is shown whenever canChangeTrack is 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 promote example, or "Console only promotes to stable" claim is left in src/, public/ or astro.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 AbhishekDoshi26 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.mdx among the pages with a version note. That page only mentions --org-id in 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 AbhishekDoshi26 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@AbhishekDoshi26
AbhishekDoshi26 merged commit 941cdbc into main Oct 12, 2026
4 checks passed
@AbhishekDoshi26
AbhishekDoshi26 deleted the docs/new-flag-names branch October 12, 2026 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant