Files
chatterino2/docs/make-release.md
2025-03-23 16:09:38 +01:00

1.8 KiB

Checklist for making a release

In the release PR

  • Updated version code in src/common/Version.hpp

  • Updated version code in CMakeLists.txt
    This can only be "whole versions", so if you're releasing 2.4.0-beta you'll need to condense it to 2.4.0

  • Add a new release at the top of the releases key in resources/com.chatterino.chatterino.appdata.xml
    This cannot use dash to denote a pre-release identifier, you have to use a tilde instead.

  • Updated version code in .CI/chatterino-installer.iss
    This can only be "whole versions", so if you're releasing 2.4.0-beta you'll need to condense it to 2.4.0

  • Update the changelog ## Unversioned section to the new version CHANGELOG.md
    Make sure to leave the ## Unversioned line unchanged for easier merges

  • Ensure all GitHub API credentials from the chatterino-ci user are still valid

After the PR has been merged

  • Tag the release
  • Manually run the create-installer workflow.
    This is only necessary if the tag was created after the CI in the main branch finished.
  • Stable release only If the winget releaser action doesn't work as expected, you can run this manually using Komac, replacing v2.5.2 with the current release:
    komac update ChatterinoTeam.Chatterino --version 2.5.2 --urls https://github.com/Chatterino/chatterino2/releases/download/v2.5.2/Chatterino.Installer.exe
  • Ensure changelog on website is up-to-date

After the binaries have been uploaded to fourtf's bucket

  • Stable release only Re-run the Publish Homebrew Cask on Release action
  • Update links in the Chatterino website to point to the new release