docs: make release prep use PR-based changelog finalization#133
Merged
Conversation
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 current release skill and maintainer docs assume the finalized changelog can be committed directly on main before tagging, which dead-ends on this repo because main is protected and rejects direct pushes.
Root cause
Release prep requires a mutating CHANGELOG.md finalization step, but the documented operator flow did not include a release-prep PR path for protected main.
Fix
Update the cut-release skill, changelog/release docs, contributor guidance, and hygiene test coverage so future release prep lands finalized changelog updates through a short-lived release-prep PR before the tag is cut from merged main.
Validation