Skip to content

Commit

Permalink
Notes on how to release
Browse files Browse the repository at this point in the history
  • Loading branch information
marcua committed Jan 8, 2025
1 parent 3f21426 commit 098d594
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,3 +396,9 @@ Here's a rough roadmap for the project, with items near the top of the list more

This project has a roadmap and features are added and tested in a certain order. I'm adding a little friction in requiring a discussion/design document for features before submitting a pull request to ensure that I can focus my attention on well-motivated, well-sequenced, and well-understood functionality.

## Notes on releasing
As we are in the early days of `ayb`, we largely do patch releases (e.g., v0.1.7 -> v0.1.8). We use [cargo-release](https://crates.io/crates/cargo-release) for this.

To install `cargo-release`, run `cargo install cargo-release`.

To perform a patch release, ensure you are on `main` and run `cargo release patch`.

0 comments on commit 098d594

Please sign in to comment.