Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/docs/release_checklist.md
François Mockers 4a649d5030
document how to publish patches (#12879) 
# Objective

- Ensure patches can be released by anyone (with the appropriate
permissions)

## Solution

- Document the process
2024-04-04 21:18:00 +00:00

2.6 KiB
Raw Blame History

Release Checklist

Minor Version

Minor Pre-release

  1. Check regressions tag.
  2. Check appropriate milestone, and close it.
  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.
    • Change the commit message to be nicer
  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:
  13. Run this workflow to update wasm examples:

Minor Release

  1. Release on crates.io
    • bash tools/publish.sh
  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

Minor 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.
  2. Update Bevy version used for Bevy book code validation to latest release.

Patch

Patch Pre-release

  1. Check appropriate milestone.
  2. Close the milestone, open the next one if anything remains and transfer them.
  3. Bump version number for all crates, using the command from the "Release" workflow locally, with patch for the new version. At the time of writing this:
    • cargo release patch --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 patch and the previous version.
  6. Bump latest tag to most recent release.
  7. Run this workflow to update screenshots:
  8. Run this workflow to update wasm examples:

Patch Release

  1. Release on crates.io
    • bash tools/publish.sh
  2. Announce on:
    1. Discord: Bevy

Patch Post-Release