From ed11a4468b80efff323b3ada2e4e19d3be462132 Mon Sep 17 00:00:00 2001 From: Viktor Charypar Date: Wed, 22 Jan 2025 10:13:18 +0000 Subject: [PATCH] Add note about versioning capabilities --- release.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/release.md b/release.md index b2ac7cca1..8387d399c 100644 --- a/release.md +++ b/release.md @@ -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