Document release branch workflow
This commit is contained in:
parent
9b2959d57d
commit
5aff417cac
1 changed files with 7 additions and 0 deletions
|
|
@ -3,6 +3,10 @@
|
||||||
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].
|
See [HCI Effects cargo publish workflow].
|
||||||
|
|
||||||
|
## Release branch
|
||||||
|
|
||||||
|
Create a `release` branch and PR for release preparation. This allows CI to validate the release before tagging.
|
||||||
|
|
||||||
## Before tagging
|
## Before tagging
|
||||||
|
|
||||||
- Update `CHANGELOG.md`:
|
- Update `CHANGELOG.md`:
|
||||||
|
|
@ -12,6 +16,9 @@ See [HCI Effects cargo publish workflow].
|
||||||
## After tagging
|
## After tagging
|
||||||
|
|
||||||
- Add a new Unreleased section to `CHANGELOG.md`
|
- Add a new Unreleased section to `CHANGELOG.md`
|
||||||
|
- Merge the release PR
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
Dissatisfied with the coarse grained release process? Complain to @roberth and he'll get it done for you.
|
Dissatisfied with the coarse grained release process? Complain to @roberth and he'll get it done for you.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue