Skip to content

Release checklist

Alexey Rusakov edited this page Nov 3, 2024 · 43 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
    • Quotient repo submodule ref
    • CI: CI Status
  • 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 the branch tag after merging
  • Check that contents of README.md, SECURITY.md, and BUILDING.md are up-to-date
  • Rebuild and smoke-test the application
  • If quaternion_en.ts is changed, review, commit and push the changes before proceeding

Actions:

  • Go to the Releases page and make a new draft:
    • Set the tag (N.M.L, must not exist yet)
    • Describe all notable fixes/enhancements
    • Thank all contributors whose commits landed in this release
  • Update the version number in main.cpp and CMakeLists.txt
  • Add a release record to linux/io.github.quotient_im.Quaternion.appdata.xml
    • Copy a summary of changes from the draft at GH to the release <description>
  • git commit
  • git tag -a N.M.L && git push --follow-tags
  • Update Flathub repo
    • Download and smoke-test the binary (check the version!); if something is off, delete the tag locally and on remotes, fix-commit-push, check that GitHub Actions are green, set again and push the same tag; a new Flathub build should start automatically
    • Merge the PR
  • Refresh the page with the version release notes
  • 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
  • Add '+git' to the version number in 'main.cpp'
  • git commit && git push
Clone this wiki locally