From d765defc0c903f4fdc6548958aac453a5cb2d8f5 Mon Sep 17 00:00:00 2001 From: Frank O'Hara Date: Fri, 7 Aug 2026 12:09:48 -0600 Subject: [PATCH] Update release runbook for PR-based workflow main now requires PRs and passing checks; tags are pushed separately. --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bb8f5a..dbd8136 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -774,14 +774,18 @@ Release with notes taken from the matching `CHANGELOG.md` section. To cut a release: -1. Bump `version` in the root `Cargo.toml` (`[workspace.package]`) +1. On a branch, bump `version` in the root `Cargo.toml` + (`[workspace.package]`) 2. Move entries from `[Unreleased]` to a new `## [X.Y.Z] - YYYY-MM-DD` section in `CHANGELOG.md` and update the link references at the bottom -3. Commit, then tag and push: +3. Open a pull request and merge it once required checks pass (`main` only + accepts changes via PR) +4. Tag the merge commit and push the tag: ```bash + git checkout main && git pull git tag vX.Y.Z - git push origin main vX.Y.Z + git push origin vX.Y.Z ``` After changing dist settings in `dist-workspace.toml`, run `dist generate` to