Skip to content

Commit

Permalink
docs: Update RELEASE.md to include explicit cargo-semver-checks install
Browse files Browse the repository at this point in the history
Signed-off-by: Melvin Wang <[email protected]>
  • Loading branch information
wmmc88 authored Dec 3, 2024
1 parent 10a8e37 commit 57edc3a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
The release process for this repository leverages [`release-plz`](https://github.com/MarcoIeni/release-plz) to automate some of the steps. Only maintainers with the necessary permissions can release new versions of this repository.

1. Install `release-plz`: One option is by running `cargo install --locked release-plz`
1. Ensure you are running the latest version of `release-plz`
1. Install `cargo-semver-checks`: One option is by running `cargo install --locked cargo-semver-checks`
1. Ensure you are running the latest version of `cargo-semver-checks`
1. Checkout the latest code on `main` branch
1. Create a release PR: `release-plz release-pr --git-token <Github Token>`
1. In the Pull Request:
Expand Down

0 comments on commit 57edc3a

Please sign in to comment.