Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 15:14:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/docs/release_checklist.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

Release Checklist (#1834) To help make the process easier and more fool-proof, aid delegation and document institutional knowledge. I'm not entirely sure where this belongs.
2021-04-08 21:33:46 +00:00
# Release Checklist
Bump Bevy to 0.7.0-dev (#4230) # Objective - The [dev docs](https://dev-docs.bevyengine.org/bevy/index.html#) show version 0.6.0, which is actively misleading. [Image of the problem](https://cdn.discordapp.com/attachments/695741366520512563/953513612943704114/Screenshot_20220316-154100_Firefox-01.jpeg) Noticed by @ickk, fix proposed by @mockersf. ## Solution - Bump the version across all Bevy crates to 0.7.0 dev. - Set a reminder in the Release Checklist to remember to do this each release.
2022-03-19 03:54:15 +00:00
## Pre-release
Release Checklist (#1834) To help make the process easier and more fool-proof, aid delegation and document institutional knowledge. I'm not entirely sure where this belongs.
2021-04-08 21:33:46 +00:00
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.
Fix release workflow (#4903) # Objective While playing with the code, I found some problems in the recently merged version-bumping workflow: - Most importantly, now that we are using `0.8.0-dev` in development, the workflow will try to bump it to `0.9.0` :sob: - The crate filter is outdated now that we have more crates in `tools`. - We are using `bevy@users.noreply.github.com`, but according to [Github help](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#about-commit-email-addresses), that email address means "old no-reply email format for the user `bevy`". It is currently not associated with any account, but I feel this is still not appropriate here. ## Solution - Create a new workflow, `Post-release version bump`, that should be run after a release and bumps version from `0.X.0` to `0.X+1.0-dev`. Unfortunately, cargo-release doesn't have a builtin way to do this, so we need to parse and increment the version manually. - Add the new crates in `tools` to exclusion list. Also removes the dependency version specifier from `bevy_ecs_compile_fail_tests`. It is not in the workspace so the dependency version will not get automatically updated by cargo-release. - Change the author email to `41898282+github-actions[bot]@users.noreply.github.com`. According to the discussion [here](https://github.com/actions/checkout/issues/13#issuecomment-724415212) and [here](https://github.community/t/github-actions-bot-email-address/17204/6), this is the email address associated with the github-actions bot account. - Also add the workflows to our release checklist. See infmagic2047#5 and infmagic2047#6 for examples of release and post-release PRs.
2022-06-06 15:47:51 +00:00
8. Bump version number for all crates, using the "Release" workflow.
Bump Bevy to 0.7.0-dev (#4230) # Objective - The [dev docs](https://dev-docs.bevyengine.org/bevy/index.html#) show version 0.6.0, which is actively misleading. [Image of the problem](https://cdn.discordapp.com/attachments/695741366520512563/953513612943704114/Screenshot_20220316-154100_Firefox-01.jpeg) Noticed by @ickk, fix proposed by @mockersf. ## Solution - Bump the version across all Bevy crates to 0.7.0 dev. - Set a reminder in the Release Checklist to remember to do this each release.
2022-03-19 03:54:15 +00:00
9. Create tag on GitHub.
10. Bump `latest` tag to most recent release.
Add "update screenshots" to release checklist (#10369)
2023-11-04 18:43:15 +00:00
11. 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_.
Bump Bevy to 0.7.0-dev (#4230) # Objective - The [dev docs](https://dev-docs.bevyengine.org/bevy/index.html#) show version 0.6.0, which is actively misleading. [Image of the problem](https://cdn.discordapp.com/attachments/695741366520512563/953513612943704114/Screenshot_20220316-154100_Firefox-01.jpeg) Noticed by @ickk, fix proposed by @mockersf. ## Solution - Bump the version across all Bevy crates to 0.7.0 dev. - Set a reminder in the Release Checklist to remember to do this each release.
2022-03-19 03:54:15 +00:00
## Release
1. Release on crates.io
2. Announce on:
Release Checklist (#1834) To help make the process easier and more fool-proof, aid delegation and document institutional knowledge. I'm not entirely sure where this belongs.
2021-04-08 21:33:46 +00:00
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
Bump Bevy to 0.7.0-dev (#4230) # Objective - The [dev docs](https://dev-docs.bevyengine.org/bevy/index.html#) show version 0.6.0, which is actively misleading. [Image of the problem](https://cdn.discordapp.com/attachments/695741366520512563/953513612943704114/Screenshot_20220316-154100_Firefox-01.jpeg) Noticed by @ickk, fix proposed by @mockersf. ## Solution - Bump the version across all Bevy crates to 0.7.0 dev. - Set a reminder in the Release Checklist to remember to do this each release.
2022-03-19 03:54:15 +00:00
## Post-release
Fix release workflow (#4903) # Objective While playing with the code, I found some problems in the recently merged version-bumping workflow: - Most importantly, now that we are using `0.8.0-dev` in development, the workflow will try to bump it to `0.9.0` :sob: - The crate filter is outdated now that we have more crates in `tools`. - We are using `bevy@users.noreply.github.com`, but according to [Github help](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#about-commit-email-addresses), that email address means "old no-reply email format for the user `bevy`". It is currently not associated with any account, but I feel this is still not appropriate here. ## Solution - Create a new workflow, `Post-release version bump`, that should be run after a release and bumps version from `0.X.0` to `0.X+1.0-dev`. Unfortunately, cargo-release doesn't have a builtin way to do this, so we need to parse and increment the version manually. - Add the new crates in `tools` to exclusion list. Also removes the dependency version specifier from `bevy_ecs_compile_fail_tests`. It is not in the workspace so the dependency version will not get automatically updated by cargo-release. - Change the author email to `41898282+github-actions[bot]@users.noreply.github.com`. According to the discussion [here](https://github.com/actions/checkout/issues/13#issuecomment-724415212) and [here](https://github.community/t/github-actions-bot-email-address/17204/6), this is the email address associated with the github-actions bot account. - Also add the workflows to our release checklist. See infmagic2047#5 and infmagic2047#6 for examples of release and post-release PRs.
2022-06-06 15:47:51 +00:00
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).
Bump Bevy to 0.7.0-dev (#4230) # Objective - The [dev docs](https://dev-docs.bevyengine.org/bevy/index.html#) show version 0.6.0, which is actively misleading. [Image of the problem](https://cdn.discordapp.com/attachments/695741366520512563/953513612943704114/Screenshot_20220316-154100_Firefox-01.jpeg) Noticed by @ickk, fix proposed by @mockersf. ## Solution - Bump the version across all Bevy crates to 0.7.0 dev. - Set a reminder in the Release Checklist to remember to do this each release.
2022-03-19 03:54:15 +00:00
2. Update Bevy version used for Bevy book code validation to latest release.
Reference in a new issue Copy permalink