Document the Release Candidate process (#13718)

# Objective

- Document how to release a RC

## Solution

- Also allow CI to trigger on release branches
This commit is contained in:
François Mockers 2024-06-07 03:56:25 +02:00 committed by GitHub
parent 98bc5ff8c4
commit ecdd1624f3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 23 additions and 0 deletions

View file

@ -6,6 +6,7 @@ on:
push: push:
branches: branches:
- main - main
- release-*
env: env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always

View file

@ -6,6 +6,7 @@ on:
push: push:
branches: branches:
- main - main
- release-*
concurrency: concurrency:
group: ${{github.workflow}}-${{github.ref}} group: ${{github.workflow}}-${{github.ref}}

View file

@ -64,3 +64,24 @@
1. Discord: Bevy 1. Discord: Bevy
### Patch Post-Release ### Patch Post-Release
## Release Candidate
### RC Pre-Release
1. Check appropriate milestone.
2. Create a branch for the release.
3. Bump version number for all crates, using the command from the "Release" workflow locally, with `rc` for the new version. At the time of writing this:
* `cargo release rc --workspace --no-publish --execute --no-tag --no-confirm --no-push --dependent-version upgrade --exclude ci --exclude errors --exclude bevy_mobile_example --exclude build-wasm-example`
* Change the commit message to be nicer
4. Create tag on GitHub.
5. Edit Github Release. Add link to the comparison between this rc and the previous version.
### RC Release
1. Release on crates.io
* `bash tools/publish.sh`
2. Announce on:
1. Discord: Bevy, #dev-announcements
### RC Post-Release