Skip to content
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

document release process #31

Merged
merged 1 commit into from
Jan 17, 2024
Merged

document release process #31

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
14 changes: 14 additions & 0 deletions releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How To Release The Crate
This guide is only relevant for maintainers.

This crate is set up to be released using [`cargo-release`](https://crates.io/crates/cargo-release),
please install it and use it to do the release. It also takes care of updating the [changelog](CHANGELOG.md).

To do the release:
1. Make sure that your local clone of the repository is up-to-date
2. Switch to a new feature branch for the release
3. Run `cargo release [level]` (see their documentation for more details) to dry-run it.
Make sure to choose the appropriate level based on semantic versioning!
4. Once you're happy with the result append `--execute`
5. After the release push the created tag & commit, create a PR & merge it
6. Create a release on GitHub based on the tag