Skip to content

Commit

Permalink
doc(publishing): changelog instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
W95Psp authored Jan 20, 2025
1 parent a527ffd commit b295ba7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,10 @@ engine. Those should not be published on `crate.io`.
2. `cargo-hax-engine-names-extract`

## Procedure
1. Bump the version number with `cargo release LEVEL --no-publish --no-tag --execute` (`cargo release --help` for more details on `LEVEL`). This will bump the version of every Rust crate, but also the version in `engine/dune-project`. This will also regenerate `engine/hax-engine.opam`. Note this will *not* publish the crate.
2. PR the change
3. when the PR is merged in main, checkout `main` and run `cargo release --execute`
1. Move the contents of `CHANGELOG.md` under the `[Unreleased]` section to a new section named following the target version
2. Bump the version number with `cargo release LEVEL --no-publish --no-tag --execute` (`cargo release --help` for more details on `LEVEL`). This will bump the version of every Rust crate, but also the version in `engine/dune-project`. This will also regenerate `engine/hax-engine.opam`. Note this will *not* publish the crate.
3. PR the change
4. when the PR is merged in main, checkout `main` and run `cargo release --execute`

Note: for now, we are not publishing to Opam. Instead, let's just advertise the following for installation:
```bash
Expand Down

0 comments on commit b295ba7

Please sign in to comment.