docs/releasing_openttd.md

   1 # Releasing OpenTTD
   2
   3 This guide is for OpenTTD developers/maintainers, to release a new version of OpenTTD.
   4
   5 ## Step 0: Branch or Backport
   6
   7 * If this is a beta version release, skip this step.
   8
   9 * If this is an RC1 (first Release Candidate) build, create a new branch `release/nn` where `nn` is the major version number, then apply changes similar to [PR#9573](https://github.com/OpenTTD/OpenTTD/pull/9573). You also need to forwardport the changelog, as in [PR#10113](https://github.com/OpenTTD/OpenTTD/pull/10113).
  10   * Update the version in `CMakeLists.txt` in the master branch, heading for the next major release, e.g. from 14.0 to 15.0.
  11   * Add a new (empty) AI compatibility script in `bin/ai/`
  12   * Add the new version to CheckAPIVersion in `src/ai/ai_info.cpp` and `src/game/game_info.cpp`
  13   * Add the new version to `src/script/api/ai_changelog.hpp` and `src/script/api/game_changelog.hpp`
  14   * Update the version of regression in `bin/ai/regression/regression_info.nut`
  15   * Add a note to `src/saveload/saveload.h` about which savegame version is used in the branch.
  16
  17 * If this is a later RC or release build and the release branch already exists, you'll need to backport fixes and language from master to this branch, which were merged after the branch diverged from master. You can use these two helper scripts: https://github.com/OpenTTD/scripts/tree/main/backport
  18
  19 * If this is a maintenance release, update the version in `CMakeLists.txt` in the release branch, e.g. from 14.0 to 14.1.
  20
  21 ## Step 1: Prepare changelog documentation
  22
  23 1. Update the [changelog](../changelog.txt) with new changes since the last release.
  24    * Changelog entries are typically PR titles, but can be edited to be more helpful without context.
  25    * Don't include fixes to things which haven't previously been released (like fixes to features which are in the same changelog).
  26    * Order the entries by importance: `Feature > Add > Change > Fix`, then numerically by PR number.
  27 2. Create a changelog PR, get approval, and merge.
  28    * For beta releases, target master, otherwise target the release branch.
  29
  30 ## Step 2: Prepare website release announcement
  31
  32 1. Go to https://github.com/OpenTTD/website/new/main/_posts and write a new announcement post. See a [previous example](https://github.com/OpenTTD/website/pull/238) for a template.
  33 2. Create a new branch for this post and open a PR for it.
  34 3. Write announcement text for the store pages and socials like TT-Forums / Discord / Twitter / Reddit / Fosstodon / etc., and include it in the PR.
  35 4. Create a Steam news image for that post and include it in the PR.
  36 5. Check the website post ("View Deployment" link) and make corrections. We usually just use the GitHub web interface for this and squash the result later.
  37 6. Get this PR approved, but do not merge yet.
  38
  39 ## Step 3: Make the actual OpenTTD release
  40
  41 1. Confirm that the version in `CMakeLists.txt` matches the intended release version.
  42 2. Go to https://github.com/OpenTTD/OpenTTD/releases/new and create a new tag matching the release number. For the body of the release, copy in the changelog. "Set as a pre-release" for a beta or RC.
  43 3. Wait for the OpenTTD release workflow to be complete.
  44 4. If this is a full release:
  45    * for `Steam`: under Steamworks -> SteamPipe -> Builds, set the "testing" branch live on the "default" branch. This will request 2FA validation.
  46    * for `GOG`: under Builds, "Publish" the freshly uploaded builds to `Master`, `GOG-use only` and `Testing`.
  47    * for `Microsoft Store`: ask orudge to publish the new release.
  48
  49 Access to `Steam`, `GOG` and/or `Microsoft Store` requires a developer account on that platform.
  50 You will need access to the shared keystore in order to create such an account.
  51 For help and/or access to either or both, please contact TrueBrain.
  52
  53 ## Step 4: Tell the world
  54
  55 1. Merge the website PR. This will publish the release post.
  56 2. Make announcements on social media and store pages. You may need to coordinate with other developers who can make posts on TT-Forums, Twitter, Reddit, Fosstodon, Discord, Steam, GOG, Microsoft Store, etc.