From 7002548933aee7b8ed72b3d4a255110414f6c5ca Mon Sep 17 00:00:00 2001 From: Piotr Roslaniec Date: Mon, 28 Aug 2023 16:57:57 +0200 Subject: [PATCH] chore(ops): add PUBLISHING.md --- PUBLISHING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 PUBLISHING.md diff --git a/PUBLISHING.md b/PUBLISHING.md new file mode 100644 index 00000000..2a109be7 --- /dev/null +++ b/PUBLISHING.md @@ -0,0 +1,25 @@ +# New version publishing instructions + +We're [cargo-smart-release](https://lib.rs/crates/cargo-smart-release) to automate the release process. + +## Writing commit messages + +As long as you adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format, you can +write your commit messages however you want. + +## Releasing workflow + +We're currently not releasing Python and WASM bindings, we're only releasing the Rust crate. + +In order to release a new version, simply run: + +```bash +cargo smart-release --update-crates-index +``` + +Inspect the changes and confirm the release: + +```bash +cargo smart-release --update-crates-index --execute +``` +