Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.29 KB

RELEASE_CHECKLIST.md

File metadata and controls

25 lines (22 loc) · 1.29 KB

Release Checklist

This is a list of steps to complete when making a new release.

  1. Review the commit and PR history since last release. Ensure that all relevant changes are included in CHANGELOG.md, and that breaking changes are specifically annotated
  2. Update the version of seed dependency in the readme.
  3. Ensure both the readme and homepage website reflect API changes. Instructions for updating the homepage are available here
  4. Update the homepage with the new release version (main page), and changelog
  5. Ensure the quickstart repo is updated to reflect API changes, and the new version
  6. Ensure the version listed in Cargo.toml is updated
  7. Update Rust tools: rustup update
  8. Run cargo make populate_all to synchronize St, At and other enums with official values
  9. Run cargo make verify to ensure tests pass, and clippy / fmt are run
  10. Commit and push the repo
  11. Check that CI pipeline passed
  12. Run cargo package
  13. Run cargo publish
  14. Add a release on Github, following the format of previous releases
  15. Verify the docs page updated correctly
  16. Clone the quickstart repo, and verify it builds and runs correctly