Skip to content

Commit efc10fa

Browse files
authored
Update release runbook for PR-based workflow (#28)
main now requires PRs and passing checks; tags are pushed separately.
1 parent 23c7e8f commit efc10fa

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -774,14 +774,18 @@ Release with notes taken from the matching `CHANGELOG.md` section.
774774

775775
To cut a release:
776776

777-
1. Bump `version` in the root `Cargo.toml` (`[workspace.package]`)
777+
1. On a branch, bump `version` in the root `Cargo.toml`
778+
(`[workspace.package]`)
778779
2. Move entries from `[Unreleased]` to a new `## [X.Y.Z] - YYYY-MM-DD` section
779780
in `CHANGELOG.md` and update the link references at the bottom
780-
3. Commit, then tag and push:
781+
3. Open a pull request and merge it once required checks pass (`main` only
782+
accepts changes via PR)
783+
4. Tag the merge commit and push the tag:
781784

782785
```bash
786+
git checkout main && git pull
783787
git tag vX.Y.Z
784-
git push origin main vX.Y.Z
788+
git push origin vX.Y.Z
785789
```
786790

787791
After changing dist settings in `dist-workspace.toml`, run `dist generate` to

0 commit comments

Comments
 (0)