Skip to content

docs(release): switch to PR-based release flow#91

Merged
hakula139 merged 1 commit into
mainfrom
docs/release-pr-workflow
Jun 25, 2026
Merged

docs(release): switch to PR-based release flow#91
hakula139 merged 1 commit into
mainfrom
docs/release-pr-workflow

Conversation

@hakula139

Copy link
Copy Markdown
Owner

Summary

Rework the release procedure to land through a PR instead of committing the version bump straight to main and 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

  • Tag the merge commit, not a fresh local commit. The previous flow committed chore(release): vX.Y.Z to main and tagged immediately, so a CI failure (e.g. an unknown crate name in the changelog tripping cspell) 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.
  • Local checks mirror CI, run before pushing. Folded the full cargo fmt / clippy / test + pnpm lint / spellcheck suite into the procedure so failures surface locally, not in CI.
  • Dropped the "If CI fails after the tag is pushed" recovery section. The PR flow makes it unreachable, so documenting recovery would only invite the old path.
  • Homebrew formula refresh also goes through a PR, consistent with the no-direct-push rule.

Changes

File Description
RELEASING.md PR-based standard release; local check suite; cspell-vs-changelog note; re-cut section trimmed
.claude/skills/release/SKILL.md Match the PR flow; reminders reordered and reworded; recovery section removed

Test plan

  • pnpm lint: 0 errors on both files
  • pnpm spellcheck: 0 issues on both files

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.
@hakula139 hakula139 self-assigned this Jun 25, 2026
@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@hakula139 hakula139 added the documentation Improvements or additions to documentation label Jun 25, 2026
@hakula139 hakula139 merged commit e553673 into main Jun 25, 2026
4 checks passed
@hakula139 hakula139 deleted the docs/release-pr-workflow branch June 25, 2026 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant