Skip to content

Commit

Permalink
Add note about versioning capabilities
Browse files Browse the repository at this point in the history
  • Loading branch information
charypar authored Jan 22, 2025
1 parent 42a4e51 commit ed11a44
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions release.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ The easiest way of releasing is using `release-plz`
Things it misses: (may not be the complete list):
* changes to crux_macros that generate incompatible code
* changes to capability operation types
2. Optionally - open a PR with the changes to the versions for review
3. use `scripts/cargo_publish.fish` to publish the crates in the right order OR

**WARNING**: If `crux_macros` or `crux_core` had a breaking change, usually it means breaking changes in capabilities
because of trait changes etc. and capabilities need a minor version bump even if their API has not changed in a breaking way
3. Optionally - open a PR with the changes to the versions for review
4. use `scripts/cargo_publish.fish` to publish the crates in the right order OR
- publish `crux_macros` if it changed
- publish `crux_core` if it changed
- publish any capability crates that changed
4. tag the commit used for the release with [crate_name]-vX.Y.Z
5. for `crux_core` create a GitHub release with release notes, especially breaking changes
5. tag the commit used for the release with [crate_name]-vX.Y.Z
6. for `crux_core` create a GitHub release with release notes, especially breaking changes

0 comments on commit ed11a44

Please sign in to comment.