Skip to content

Commit 25306e7

Browse files
committed
Document the Release Candidate process (#13718)
# Objective - Document how to release a RC ## Solution - Also allow CI to trigger on release branches
1 parent ce19b0f commit 25306e7

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
push:
77
branches:
88
- main
9+
- release-*
910

1011
env:
1112
CARGO_TERM_COLOR: always

.github/workflows/validation-jobs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
push:
77
branches:
88
- main
9+
- release-*
910

1011
concurrency:
1112
group: ${{github.workflow}}-${{github.ref}}

docs/release_checklist.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,24 @@
6464
1. Discord: Bevy
6565

6666
### Patch Post-Release
67+
68+
## Release Candidate
69+
70+
### RC Pre-Release
71+
72+
1. Check appropriate milestone.
73+
2. Create a branch for the release.
74+
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:
75+
* `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`
76+
* Change the commit message to be nicer
77+
4. Create tag on GitHub.
78+
5. Edit Github Release. Add link to the comparison between this rc and the previous version.
79+
80+
### RC Release
81+
82+
1. Release on crates.io
83+
* `bash tools/publish.sh`
84+
2. Announce on:
85+
1. Discord: Bevy, #dev-announcements
86+
87+
### RC Post-Release

0 commit comments

Comments
 (0)