Skip to content

Release checklist

Jump to bottom Edit New page
Alexey Rusakov edited this page Jul 3, 2023 · 34 revisions

Pre-check:

  • There are no pending issues in the Roadmap for this release (if there are, move them away or close them)
  • (If API/ABI breakage is allowed) Check out the latest matrix-spec and make update-api
    • If there are changes, review/commit/push them
  • Check the latest branch/commit:
    • in the repo
    • GitHub Actions: libQuotient:GHA
  • Check the version number in CMakeLists.txt
  • Rebuild (from scratch) all targets with GCC and check autotests+quotest
  • Check that the documentation is up to date
    • README.md
    • CONTRIBUTING.md
    • SECURITY.md

Actions:

  • Go to the Releases page and make a draft for release notes:
    • Thank all contributors whose commits landed in this release
    • Describe all notable fixes/enhancements/API breakage
  • git commit && git push, if not yet
  • Finalise the release at GitHub:
    • Fill in the tag (should be "N.M.L", NOT "N.M")
    • Publish release notes (the title should be "###", not "Version ###")
  • Update the topic in #quotient
  • Post a TWIM update

Post-check:

  • Open the release page in Incognito/Privacy mode; check the version and the Git tag
Add a custom footer
Add a custom sidebar
Clone this wiki locally