docs: explain the stage graph mental model#244
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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
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.
Problem
New adopters lack a single page that shows how cascade moves a change from trunk through the environment chain to a release, and where rollback and hotfix branch off. The capabilities are documented piece by piece, but the mental model is not (#179).
Fix
Adds a new narrative
Stage Graphpage (docs/src/content/docs/stage-graph.md) derived frominternal/generate/plan.goandinternal/config/types.go:environmentsorder) -> the prerelease/release boundary, with rollback and hotfix off-ramps.orchestrate.yaml), promote/release (promote.yaml/release.yaml), the positional prerelease/release boundary, rollback (cascade-rollback.yaml), hotfix (cascade-hotfix.yaml), and the opt-in supporting stages: external-update, validate, merge-queue, pr-preview, drift-check (+ comment companion).index.mdx,getting-started.md, and the README docs table.Also folds in a small security note in the
drift_checkconfiguration section: recommendpin_mode: shawhen enablingdrift_check.comment, since the comment companion runsactions/github-scriptin a write-scopedworkflow_runjob and the product defaultpin_mode: tagfloats that tag.Verification
npm run buildindocs/(Node 22) completes; 13 pages built, including the new/stage-graph/route. The mermaid block and the new sidebar entry are present in the built HTML.plan.goand the generators (orchestrate on trunk push + dispatch; promote on dispatch; the second-from-top env is the prerelease marker and the top env is the release marker).Closes #179