bevy/docs/release_checklist.md
Ame bc7ac780fb
Add a release step, add links to the github release note (#12041)
# Objective

Add a release step to add the links `Release anouncement` and `Migration
guide` to the GitHub release note.

-
https://github.com/bevyengine/bevy/issues/12011#issuecomment-1955342378
2024-02-23 18:36:07 +00:00

34 lines
1.3 KiB
Markdown

# Release Checklist
## Pre-release
1. Check regressions tag.
2. Check appropriate milestone.
3. Check GitHub Projects page for staleness.
4. Update change log.
5. Create migration guide.
6. Write blog post.
7. Update book.
8. Bump version number for all crates, using the "Release" workflow.
9. Create tag on GitHub.
10. Edit Github Release. Add links to the `Release announcement` and `Migration Guide`
11. Bump `latest` tag to most recent release.
12. Run this workflow to update screenshots:
* <https://github.com/bevyengine/bevy-website/actions/workflows/update-screenshots.yml>
* _This will block blog post releases (and take ~40 minutes) so do it early_.
## Release
1. Release on crates.io
2. Announce on:
1. HackerNews
2. Twitter
3. Reddit: /r/bevy, /r/rust, /r/rust_gamedev
4. Discord: Bevy, Game Development in Rust, Rust Programming Language Community
5. This Month in Rust Game Development newsletter
6. This Week in Rust newsletter
## Post-release
1. Bump version number for all crates to next versions, as `0.X-dev`, using the "Post-release version bump" workflow, to ensure properly displayed version for [Dev Docs](https://dev-docs.bevyengine.org/bevy/index.html).
2. Update Bevy version used for Bevy book code validation to latest release.