Skip to content

Commit

Permalink
chore(ops): add PUBLISHING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
piotr-roslaniec committed Aug 28, 2023
1 parent 9c1970b commit 7002548
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 7002548

Please sign in to comment.