docs: document the staging branch flow#625
Merged
Merged
Conversation
CONTRIBUTING gains a Branch Flow section so contributors know to target staging (not develop) and how the auto-promotion PRs are wired. README's Typical-patch-flow line is updated accordingly.
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.
Summary
Documents the staging branch lane that was wired up by PR #623, so contributors know where to target their PRs.
What changes
CONTRIBUTING.md: new "Branch Flow" section right after Build & Test Commands. Names the three branches that participate in the release lane (staging,develop,main), spells out that feature PRs targetstaging, links the two auto-promotion workflows, and shows the flow as ASCII.README.md: updates the "Typical patch flow" sentence so it starts fromstaginginstead ofdevelop.Note
This is the first PR opened against
staging— it doubles as a smoke test for the new lane.Test plan
staging,auto-staging-pr.yamlopens the expectedPromote: staging → developPR.