docs(release): switch to PR-based release flow#91
Merged
Conversation
Cut releases through a PR (bump, changelog, CI, review, merge) and tag only the merged commit, instead of committing the bump straight to main and tagging it. Tagging a reviewed, CI-green commit removes the amend vs. follow-up-commit dilemma when CI flags something after the fact. Fold in the local pre-push check suite and the cspell-vs-changelog gotcha so problems surface before the PR rather than in CI.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Rework the release procedure to land through a PR instead of committing the version bump straight to
mainand tagging it. The bump and changelog go on a branch, CI runs, the PR is reviewed and merged, and only then is the merged commit tagged. Tagging a reviewed, CI-green commit removes the amend-vs-follow-up-commit dilemma that arises when CI flags something after a direct-to-main tag.Design decisions
chore(release): vX.Y.Ztomainand tagged immediately, so a CI failure (e.g. an unknown crate name in the changelog trippingcspell) left a published release on a red commit, forcing either a history-rewriting re-cut or a cosmetically-red follow-up. Gating on a PR makes both unreachable.cargo fmt / clippy / test+pnpm lint / spellchecksuite into the procedure so failures surface locally, not in CI.Changes
RELEASING.md.claude/skills/release/SKILL.mdTest plan
pnpm lint: 0 errors on both filespnpm spellcheck: 0 issues on both files