docs: cut releases from a release branch, and keep the tag's headings - #39
Merged
Merged
Conversation
Two things the 1.1.0 release ran into: - A `dev` -> `main` release PR deletes `dev` when it merges: the repository deletes merged head branches and `dev` is not protected. The release commit now goes on `release/X.Y.Z`, and after the squash `main` is merged back into `dev` so it stays an ancestor. - `git tag -a -m` strips every line starting with `#` as a comment, so the v1.0.2 tag lost all of its `###` headings. The runbook now tags with `--cleanup=verbatim -F`. It also says to run the integration suite before merging the release PR, since CI does not. Co-Authored-By: Claude Opus 5.5 <[email protected]>
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
Two things the 1.1.0 release ran into:
dev→mainrelease PR deletesdevwhen it merges. The repository deletes merged head branches, anddevis not protected. The runbook now:release/X.Y.Z(the PR base guard already allowsrelease/*);mainback intodevsomainstays an ancestor. That is a plain push, not a force push.git tag -a -mstrips every line starting with#as a comment. The v1.0.2 tag lost all of its###headings. Tagging now uses--cleanup=verbatim -F.The runbook also says to run the integration suite before merging the release PR, because CI doesn't.
CONTRIBUTING.mdand the PR template name the release branch instead ofdev.🤖 Generated with Claude Code