|
2 | 2 |
|
3 | 3 | This is a list of steps to complete when making a new release.
|
4 | 4 |
|
5 |
| -1. Review the commit and PR history since last release. Ensure that all relevant |
| 5 | +# Before the release |
| 6 | + |
| 7 | +- [ ] 1. Create a new issue in the Seed repo with the name `Seed x.x.x` and copy-paste this checklist into it (also add blockers and additional tasks, if exist). |
| 8 | +- [ ] 2. Update all official examples. |
| 9 | +- [ ] 3. Review the commit and PR history since last release. Ensure that all relevant |
6 | 10 | changes are included in `CHANGELOG.md`, and that breaking changes
|
7 |
| -are specifically annotated |
8 |
| -1. Update the version of seed dependency in the readme. |
9 |
| -1. Ensure both the readme and homepage website reflect API changes. Instructions |
10 |
| -for updating the homepage are available [here](https://github.com/seed-rs/seed-homepage) |
11 |
| -1. Update the homepage with the new release version (main page), and changelog |
12 |
| -1. Ensure the [quickstart repo](https://github.com/seed-rs/seed-quickstart) is updated |
13 |
| -to reflect API changes, and the new version |
14 |
| -1. Ensure the version listed in `Cargo.toml` is updated |
15 |
| -1. Update Rust tools: `rustup update` |
16 |
| -1. Run `cargo make populate_all` to synchronize `St`, `At` and other enums with official values |
17 |
| -1. Run `cargo make verify` to ensure tests pass, and `clippy` / `fmt` are run |
18 |
| -1. Commit and push the repo |
19 |
| -1. Check that CI pipeline passed |
20 |
| -1. Run `cargo package` |
21 |
| -1. Run `cargo publish` |
22 |
| -1. Add a release on [Github](https://github.com/seed-rs/seed/releases), following the format of previous releases |
23 |
| -1. Verify the [docs page](https://docs.rs/seed/) updated correctly |
24 |
| -1. Clone the quickstart repo, and verify it builds and runs correctly |
| 11 | +are specifically annotated. |
| 12 | +- [ ] 4. Ensure the `README.md` reflects API changes. |
| 13 | +- [ ] 5. Update the `CHANGELOG.md` with the new release version. |
| 14 | +- [ ] 6. Ensure the version listed in `Cargo.toml` is updated. |
| 15 | +- [ ] 7. Update Rust tools: `rustup update`. |
| 16 | +- [ ] 8. Run `cargo make populate_all` to synchronize `St`, `At` and other enums with official values. |
| 17 | +- [ ] 9. Run `cargo make verify` to ensure tests pass, and `clippy` / `fmt` are run. |
| 18 | +- [ ] 10. Commit and push the repo. |
| 19 | +- [ ] 11. Check that CI pipeline passed. |
| 20 | +- [ ] 12. Run `cargo package`. |
| 21 | +- [ ] 13. Run `cargo publish`. |
| 22 | +- [ ] 14. Add a release on [Github](https://github.com/seed-rs/seed/releases), following the format of previous releases. |
| 23 | +- [ ] 15. Verify the [docs page](https://docs.rs/seed/) updated correctly. |
| 24 | + |
| 25 | +# After the release |
| 26 | + |
| 27 | +- [ ] 16. Update all quickstarts. |
| 28 | +- [ ] 17. Write documentation for the current release on the website. |
| 29 | +- [ ] 18. Make sure the website's version selector shows the released version by default. |
| 30 | +- [ ] 19. Notify authors of community tutorials, quickstarts and examples about a new Seed version. |
| 31 | +- [ ] 20. Write announcements (chat, forum, etc.). |
25 | 32 |
|
0 commit comments