From b22cf21aacec35b0e61359597495c3393435621c Mon Sep 17 00:00:00 2001 From: Richard Wheeler <2762690+zephyris@users.noreply.github.com> Date: Wed, 27 Aug 2025 21:30:01 +0100 Subject: [PATCH] Doc: Update to correctly explain Github releases-based workflow --- docs/releasing-opengfx2.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/releasing-opengfx2.md b/docs/releasing-opengfx2.md index ced2c04..2dfdf05 100644 --- a/docs/releasing-opengfx2.md +++ b/docs/releasing-opengfx2.md @@ -4,11 +4,17 @@ * `CHANGELOG.md` with key fixes and features 2. Bump the versions: - * User facing version in `makefile` - * Base set version in `baseset/baseset_generate_obg.py` - * Base set version string in `baseset/lang/english.lng` - * Base set `extra.grf` version in `baseset/nml/extra-header.pnml` - * NewGRF versions in `newgrf/nml//-header.pmnl` - * `extra.grf`/`opengfx2_settings.grf` co-compatibility check in `baseset/nml/extra-header.pnml` + * Base set version in `baseset/baseset_generate_obg.py` (`descriptionversion`) + * Base set `extra.grf` version in `baseset/nml/extra-header.pnml` (`grf` block, `version`) + * NewGRF versions in `newgrf/nml//-header.pmnl` (`grf` block, `version`) + * `extra.grf`/`opengfx2_settings.grf` co-compatibility check in `baseset/nml/extra-header.pnml` (in `if (grf_future_status("OGZ\1")==1)` block) + +The main user facing version in `makefile` (`NAMING_VERSION`) is automatically taken from the repository version. For better or worse, base set currently uses fractional (0.1, 0.2, ...) versioning and NewGRFs use integer (1, 2, ...) versioning. + +3. On Github, go to "Releases", "Draft a new release": + * Draft the release text (a refined copy of the changelog) and title. + * Attach baseset (both Classic and High Def) `tar`s and NewGRF `grf`s + * Create a new tag with the appropriate version. +Creation of the new version tag on publishing the release will trigger a new release to the OpenTTD CDN.