Skip to content

Commit fccd68e

Browse files
authored
Merge pull request #31 from rursprung/add-releasing-docs
document release process
2 parents 68641c2 + 190fccc commit fccd68e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

releasing.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# How To Release The Crate
2+
This guide is only relevant for maintainers.
3+
4+
This crate is set up to be released using [`cargo-release`](https://crates.io/crates/cargo-release),
5+
please install it and use it to do the release. It also takes care of updating the [changelog](CHANGELOG.md).
6+
7+
To do the release:
8+
1. Make sure that your local clone of the repository is up-to-date
9+
2. Switch to a new feature branch for the release
10+
3. Run `cargo release [level]` (see their documentation for more details) to dry-run it.
11+
Make sure to choose the appropriate level based on semantic versioning!
12+
4. Once you're happy with the result append `--execute`
13+
5. After the release push the created tag & commit, create a PR & merge it
14+
6. Create a release on GitHub based on the tag

0 commit comments

Comments
 (0)