sd/RELEASE.md
2023-11-05 13:16:09 -06:00

877 B

Release checklist

  1. Create a new "Release v{VERSION}" issue with this checklist
    • $ cat RELEASE.md | sd '\{VERSION\}' '{NEW_VERSION}' | xclip -sel clip
    • Create the issue in GitHub
  2. Regenerate static assets
    • $ cargo xtask gen
  3. Update rust-version in Cargo.toml
    • $ cargo msrv --min 1.60 -- cargo check
  4. Bump version in Cargo.toml
  5. Run cargo check to propogate the change to Cargo.lock
  6. Update the CHANGELOG.md
  7. Merge changes through a PR to make sure that CI passes
  8. Publish on crates.io
    • $ cargo publish
  9. Publish on GitHub by pushing a version tag
    • Make sure the branch you're on is fully up to date
    • $ git tag v{VERSION}
    • $ git push upstream/origin v{VERSION}
  10. Make a release announcement on GitHub after the release workflow finishes