Release Checklist

This is a checklist of all the steps to perform for building and publishing a release.

Before Build

• Backport all pending changes to the release/2.{MAJOR_VERSION}.x branch.
• Update list of (VIP) Patreon supporters and GitHub sponsors in src/gui/AboutDialog.cpp. Collect the changes from all maintainers in a PR targeting the release branch.
• Add output of ./release-tool.py i18n tx-list-translators --resource master to src/gui/AboutDialog.cpp and commit changes to supporter PR. Approve and merge the PR.
• Update version number in CMakeLists.txt and vcpkg.json.
• Update CHANGELOG.md.
• Add new version to share/linux/org.keepassxc.KeePassXC.appdata.xml and copy changelog as XML list.
• Run ./release-tool check {VERSION} and fix any reported errors.
• Tag the new release with ./release-tool.py tag {VERSION} and push tags as instructed. This will also pull and commit translations.

Build Steps

• Build src bundle:

  ./release-tool build-src {VERSION}
  

• Windows: Build amd64 and arm64 binaries:

  ./release-tool build {VERSION} --sign --sign-identity {ID} --platform-target [arm64|amd64]
  

• macOS: Build x86_64 and arm64 binaries:

  ./release-tool build {VERSION} --sign --notarize --platform-target [x86_64|arm64]
  

• AppImage: Pull current CI image and build amd64 binary:

  docker pull ghcr.io/keepassxreboot/keepassxc-ci-docker:focal-qt5.15
  ./release-tool build {VERSION} --appimage \
      --docker-image ghcr.io/keepassxreboot/keepassxc-ci-docker:focal-qt5.15
  

After Build

• Test install/run the built binaries (main and CLI).
• Check settings dialog and passphrase generator for correct bundling of translations and word lists.
• Windows: Check correct bundling of all DLLs.
• AppImage: Check existence of Auto-Type tab on X11.
• Check binaries and src bundle with VirusTotal.
• Sign binaries and src bundle with ./release-tool gpgsign {FILES...}.
• Upload src bundle, binaries, and signatures/digests to GitHub.
• Submit Ubuntu PPA builds.
• Submit Flatpak build.
• Submit Snap build.
• Submit Microsoft store update.
• Publish blog post.