Skip to content

Commit

Permalink
CONTRIBUTING.md: Add release instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
gibbz00 committed Feb 11, 2024
1 parent b01dad4 commit 50cdda2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,16 @@ mdbook test
### Building the book locally

Both [`mdbook`](https://rust-lang.github.io/mdBook/guide/installation.html) and the [`mdbook-cmdrun`](https://github.com/FauconFan/mdbook-cmdrun?tab=readme-ov-file#getting-started) processor will need to be installed before running `mdbook serve --open` or the like.

## Release (for maintainers)

1. Make sure CI is [not failing](https://github.com/gibbz00/rops/actions/workflows/ci.yml).
2. Bump version in the workspace `Cargo.toml` file.
3. Move the unreleased section in the CHANGELOG.md into a release with the current date added.
4. Finally:

```sh
git commit -am "Prepare X.X.X release."
git tag "X.X.X"
git push && git push --tags
```

0 comments on commit 50cdda2

Please sign in to comment.