docs: channel branches in release workflow + promotion-PR check behavior#116
Merged
Merged
Conversation
- Release workflow examples: comment that channel branches go in the push trigger too, and switch the concurrency group to per-ref so a channel publish doesn't queue behind / get cancelled by a main release (the lesson from dogfooding the next channel). - Concurrency section: explain the per-ref group and when it matters. - prereleases.md setup: note existing single-group workflows need the per-ref change. - cli.md: document what 'ci check' shows on channel and promotion PRs.
…d example already covers it)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc gaps surfaced while dogfooding the
nextchannel to completion. Docs-only; no bump file (nothing underpackages/changes).Release workflow examples (
github-actions.md) — both the split-jobs and single-job examples now:pushtrigger too ([main, next, beta]), with a link to the channels doc, andbumpy-release-${{ github.ref }}). With a single shared group, anextprerelease publish queues behind — or, withcancel-in-progress: true, gets cancelled by — amainrelease, despite touching different dist-tags. This is the exact lesson from our ownrelease.yaml. The standalone Concurrency section now explains the why, and notes the plain group is equivalent if you only release frommain.prereleases.mdsetup — the "only trigger change" line now also flags that an existing workflow on a single concurrency group should switch to per-ref (new workflows get it from the example).cli.md— documents whatci checkposts on channel PRs (prerelease plan,-<preid>.x, dist-tag) and on promotion PRs (reads.bumpy/<channel>/, shows the consolidated stable plan, calls out that merging ends the cycle) — behavior that shipped in #111/#113 but wasn't in the command reference.Not included here: the auto-close-promoted-release-PR docs ride with #115; nothing here references that unmerged behavior.