Skip to content

Release checklist

Alexey Rusakov edited this page Jul 11, 2023 · 45 revisions

Pre-check:

  • Make/ask to make a screenshot highlighting new features
    • Add a screenshot to the gallery and update it in the source tree
  • There are no pending issues in the Roadmap for this release (if there are, move them away or close them)
  • Check the correct branch/commit:
    • in the Quaternion repo
    • in the Quotient repo (mind super-project-pointer)
    • GitHub Actions
  • Make sure the required version of libQuotient in CMakeLists.txt is up-to-date
  • Pull translations
    • If needed, update the list of languages in CMakeLists.txt
    • Unset actual tag after merging
  • Check that contents of README.md, SECURITY.md, and BUILDING.md are up-to-date
  • If quaternion_en.ts is changed, review, commit and push the changes before proceeding
  • Rebuild and smoke-test the application

Actions:

  • Update the version number in main.cpp and CMakeLists.txt
  • 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
    • Copy a summary of changes to the release <description>
  • git commit && git push
  • Finalise the release at GitHub:
    • Fill in the tag ("N.M.L", not "vN.M.L")
    • Publish release notes
    • Update the Releases Wiki page
  • Update Flathub repo
  • Update the topic in #quaternion
  • Post a TWIM update

Post-release:

  • Open the release page in Incognito/Privacy mode; check:
    • the version
    • the Git tag
    • the screenshot
    • Check the pre-release checkbox if this version is a beta or release candidate
    • download and smoke-test the flatpak
  • Add '+git' to the version number in 'main.cpp'
  • git commit && git push
Clone this wiki locally