docs: describe multi-commit, multi-env hotfix chains - #263
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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
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.
Problem
The hotfix docs (cli-reference, workflows) still described a single-commit, single-environment hotfix, omitting --commits, the bottom-up chain elevation, and the conflict-halt plus re-engage behavior.
Fix
Document --commits (comma-delimited set, mutually exclusive with --commit), the bottom-up elevation across the env chain to the target, per-(commit,env) idempotency, all-commits-recorded-in-patches, the env_sequence/commits_ plan outputs, and the conflict-halt narrative. Touch-ups to README and versioning. The existing divergence-promote guard and prod/first-env rules are left unchanged.
Verification
cd docs && npm ci && npm run build -> 13 pages, build complete. Wording cross-checked against internal/hotfix and internal/generate/hotfix.go. Docs-only; no .go/internal/cmd/e2e touched.