Skip to content

Commit

Permalink
Document the Release Candidate process (#13718)
Browse files Browse the repository at this point in the history
# Objective

- Document how to release a RC

## Solution

- Also allow CI to trigger on release branches
  • Loading branch information
mockersf committed Jun 7, 2024
1 parent 2bb8227 commit a2580fe
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
push:
branches:
- main
- release-*

env:
CARGO_TERM_COLOR: always
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/validation-jobs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
push:
branches:
- main
- release-*

concurrency:
group: ${{github.workflow}}-${{github.ref}}
Expand Down
21 changes: 21 additions & 0 deletions docs/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,24 @@
1. Discord: Bevy

### 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

0 comments on commit a2580fe

Please sign in to comment.