Document release process in full
Adopted the complete workflow from the HCI Effects cargo publish documentation rather than referencing it, making the steps explicit and self-contained.
This commit is contained in:
parent
9f2c7a2013
commit
b8c741dfe9
1 changed files with 12 additions and 14 deletions
|
|
@ -1,22 +1,20 @@
|
||||||
# Release process
|
# Release process
|
||||||
|
|
||||||
This project uses simple tags, that trigger a release of all crates using Hercules CI.
|
This project uses simple tags, that trigger a release of all crates using Hercules CI.
|
||||||
See [HCI Effects cargo publish workflow].
|
Based on the [HCI Effects cargo publish workflow].
|
||||||
|
|
||||||
## Release branch
|
## Steps
|
||||||
|
|
||||||
Create a `release` branch and PR for release preparation. This allows CI to validate the release before tagging.
|
1. Create a `release` branch
|
||||||
|
2. Decide the version bump (patch for fixes, minor for features, major for breaking changes)
|
||||||
## Before tagging
|
3. Update `CHANGELOG.md`: make sure the Unreleased section is up to date, then change it to the new version and release date
|
||||||
|
4. Open a draft release PR and wait for CI to pass
|
||||||
- Update `CHANGELOG.md`:
|
5. Create and push a tag matching the version
|
||||||
- Make sure the Unreleased section is up to date
|
6. Add a new Unreleased section to `CHANGELOG.md`
|
||||||
- Change it to the new version and release date
|
7. Bump version in all `Cargo.toml` files to the next patch version (e.g., `0.2.0` → `0.2.1`)
|
||||||
|
and run `cargo update --workspace` to update `Cargo.lock`,
|
||||||
## After tagging
|
so that `cargo publish --dry-run` passes on subsequent commits
|
||||||
|
8. Merge the release PR
|
||||||
- Add a new Unreleased section to `CHANGELOG.md`
|
|
||||||
- Merge the release PR
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue