Skip to content

Release checklist

Alexey Rusakov edited this page Feb 22, 2021 · 43 revisions

Pre-check:

  • There are no pending issues in the Roadmap for this release (if there are, move them away or close them)
  • Check the latest branch/commit:
    • in the Quaternion repo
    • in the Quotient repo (mind super-project-pointer)
    • GitHub Actions
  • Make sure dependent versions in CMakeLists.txt are up-to-date (Quotient, Qt Keychain)
  • Pull translations
    • If needed, update the list of languages in CMakeLists.txt
  • cmake --build . --target trbase should not change quaternion_en.ts; if it does, review, commit and push the changes before proceeding
  • Check that contents of README.md, SECURITY.md, and BUILDING.md are up-to-date
  • Rebuild and smoke-test the application

Actions:

  • Update the version number in main.cpp and CMakeLists.txt
  • Make/ask to make a screenshot highlighting new features
    • Add a screenshot to the gallery and update it in the source tree
  • 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
  • Add a release record to linux/com.github.quaternion.appdata.xml
  • git commit && git push
  • Finalise the release at GitHub:
    • Fill in the tag (plain version, no more leading v/rc)
    • Publish release notes
    • Update the Releases Wiki page
  • Update the topic in #quaternion
  • Update Flathub repo

Post-release:

  • Open the release page in Incognito/Privacy mode; check:

    • the version (should be "Version ###")
    • the Git tag
    • the screenshot
    • download both Windows archives, unpack and smoke-test
  • Add '+git' to the version number in 'main.cpp'

  • git commit && git push

  • Congratulate everyone and have a drink :)

Clone this wiki locally