From 190fccc1c31e2fa7ef6a6faa6350c4fd40822ec9 Mon Sep 17 00:00:00 2001 From: Ralph Ursprung Date: Wed, 17 Jan 2024 21:45:13 +0100 Subject: [PATCH] document release process --- releasing.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 releasing.md diff --git a/releasing.md b/releasing.md new file mode 100644 index 0000000..2ae8bee --- /dev/null +++ b/releasing.md @@ -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