Skip to content

Doc: Update to correctly explain Github releases-based workflow #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zephyris merged 1 commit into from
Dec 2, 2025
Merged

Doc: Update to correctly explain Github releases-based workflow #212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions docs/releasing-opengfx2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<newgrf_name>/<newgrf_name>-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/<newgrf_name>/<newgrf_name>-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.