Skip to content

Commit

Permalink
docs: Add section on creating a new release to the contributor guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
markgoddard committed Sep 13, 2024
1 parent 5eafa93 commit 52e39b9
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,12 @@ Updating the Reductionist MSRV requires making changes in a few places.
1. Prerequisites section in `docs/contributing.md`

Updating the MSRV typically requires a few updates to the code to handle changes in the standard library, Clippy rules, etc.

### Create a release

To update the version of Reductionist, set `[package] version` in `Cargo.toml`.
Create a pull request, approve and merge it.
When ready to release, [draft a new release](https://github.com/stackhpc/reductionist-rs/releases/new) in GitHub, creating a new tag matching Reductionist's version, and auto-generating release notes.

After the release is published, the [publish.yml](https://github.com/stackhpc/reductionist-rs/blob/main/.github/workflows/publish.yml) workflow will be triggered.
This workflow publishes the crate to crates.io, and builds then publishes a container image on GHCR.

0 comments on commit 52e39b9

Please sign in to comment.