Skip to content

Document the release process #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicholasbishop merged 1 commit into from
Jul 15, 2025
Merged

Document the release process #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Release process

1. `git checkout master && git pull`
2. `git checkout -b <some-branch-name>`
3. Update the `version` field in `Cargo.toml`.
5. Update `CHANGELOG.md`.
6. Commit `Cargo.toml` and `CHANGELOG.md`. The commit message must start
with `release:`.
7. Push the branch and create a PR.
8. Merge the PR in "Rebase and merge" mode (to preserve the commit subject).

After merging, the new release will automatically be created on
<https://crates.io>. A git tag will also be created automatically.

See <https://crates.io/crates/auto-release> for more details of how the
release process is implemented.