|
1 | 1 | # How to release a new version of OpenGFX2 |
2 | 2 |
|
3 | | -1. Update the changelog: |
| 3 | +1. Update the changelog and bump the version: |
4 | 4 | * `CHANGELOG.md` with key fixes and features |
| 5 | + * User-facing version `USER_VERSION` in `makefile` |
5 | 6 |
|
6 | | -2. Bump the versions: |
7 | | - * Base set version in `baseset/baseset_generate_obg.py` (`descriptionversion`) |
8 | | - * Base set `extra.grf` version in `baseset/nml/extra-header.pnml` (`grf` block, `version`) |
9 | | - * NewGRF versions in `newgrf/nml/<newgrf_name>/<newgrf_name>-header.pmnl` (`grf` block, `version`) |
10 | | - * `extra.grf`/`opengfx2_settings.grf` co-compatibility check in `baseset/nml/extra-header.pnml` (in `if (grf_future_status("OGZ\1")==1)` block) |
| 7 | +Make a PR and, once merged: |
11 | 8 |
|
12 | | -The main user facing version in `makefile` (`NAMING_VERSION`) is automatically taken from the repository version. |
13 | | - |
14 | | -For better or worse, base set currently uses fractional (0.1, 0.2, ...) versioning and NewGRFs use integer (1, 2, ...) versioning. |
| 9 | +2. Do a clean build of master: |
| 10 | + * `make clean && make all` |
15 | 11 |
|
16 | 12 | 3. On Github, go to "Releases", "Draft a new release": |
17 | | - * Draft the release text (a refined copy of the changelog) and title. |
18 | | - * Attach baseset (both Classic and High Def) `tar`s and NewGRF `grf`s |
19 | | - * Create a new tag with the appropriate version. |
20 | | -Creation of the new version tag on publishing the release will trigger a new release to the OpenTTD CDN. |
| 13 | + * Draft the release text (a refined copy of the changelog) and title |
| 14 | + * Attach baseset (both Classic and High Def) `tar`s from `baseset/` and NewGRF `grf`s from `newgrf`. |
| 15 | + * Create a new tag with the user-facing version |
| 16 | +Creation of the new version tag on publishing the release will trigger a new release to the [OpenTTD CDN](https://cdn.openttd.org/opengfx2_classic-releases/) under the user-facing version. |
0 commit comments