SDL/docs/release_checklist.md

# Release checklist

When changing the version, run `build-scripts/update-version.sh X Y Z`,
where `X Y Z` are the major version, minor version, and patch level. So
`2 28 1` means "change the version to 2.28.1". This script does much of the
mechanical work.


## New feature release

* Update `WhatsNew.txt`

* Bump version number to 2.EVEN.0:

    * `./build-scripts/update-version.sh 2 EVEN 0`

* Do the release

## New bugfix release

* Check that no new API/ABI was added

    * If it was, do a new feature release (see above) instead

* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is even)

    * `./build-scripts/update-version.sh 2 Y Z+1`

* Do the release

## After a feature release

* Create a branch like `release-2.24.x`

* Bump version number to 2.ODD.0 for next development branch

    * `./build-scripts/update-version.sh 2 ODD 0`

## New development prerelease

* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is odd)

    * `./build-scripts/update-version.sh 2 Y Z+1`

* Do the release
docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 13:09:12 +00:00			`# Release checklist`

Moved test/versioning.sh to build-scripts/test-versioning.sh Reference Issue #6171. 2022-09-28 13:09:21 +00:00			When changing the version, run `build-scripts/update-version.sh X Y Z`,
			where `X Y Z` are the major version, minor version, and patch level. So
			`2 28 1` means "change the version to 2.28.1". This script does much of the
			`mechanical work.`


Switch versioning scheme to be the same as GLib and Flatpak For stable releases, this gives us the ability to make bugfix-only point releases such as 2.24.1 if we want to, and distinguish between them programmatically. For example, this ability could have been useful after 2.0.16 to fix Xwayland regressions, and after 2.0.18 to fix event loop regressions. For development releases, this gives us the ability to make multiple prereleases during the same feature cycle, and distinguish between them programmatically. For example, this would have been useful during 2.0.22 development, which went through three prereleases before reaching the final release. Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 14:16:11 +00:00			`## New feature release`

docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 13:09:12 +00:00			* Update `WhatsNew.txt`

build-scripts: Added update-version.sh Fixes #6171. 2022-09-28 02:03:26 +00:00			`* Bump version number to 2.EVEN.0:`
docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 13:09:12 +00:00
build-scripts: Added update-version.sh Fixes #6171. 2022-09-28 02:03:26 +00:00			* `./build-scripts/update-version.sh 2 EVEN 0`
Note that we should regenerate configure before running test/versioning.sh 2022-09-05 18:25:10 +00:00
docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 13:09:12 +00:00			`* Do the release`

Switch versioning scheme to be the same as GLib and Flatpak For stable releases, this gives us the ability to make bugfix-only point releases such as 2.24.1 if we want to, and distinguish between them programmatically. For example, this ability could have been useful after 2.0.16 to fix Xwayland regressions, and after 2.0.18 to fix event loop regressions. For development releases, this gives us the ability to make multiple prereleases during the same feature cycle, and distinguish between them programmatically. For example, this would have been useful during 2.0.22 development, which went through three prereleases before reaching the final release. Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 14:16:11 +00:00			`## New bugfix release`

			`* Check that no new API/ABI was added`

			`* If it was, do a new feature release (see above) instead`

			`* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is even)`

build-scripts: Added update-version.sh Fixes #6171. 2022-09-28 02:03:26 +00:00			* `./build-scripts/update-version.sh 2 Y Z+1`
Note that we should regenerate configure before running test/versioning.sh 2022-09-05 18:25:10 +00:00
Switch versioning scheme to be the same as GLib and Flatpak For stable releases, this gives us the ability to make bugfix-only point releases such as 2.24.1 if we want to, and distinguish between them programmatically. For example, this ability could have been useful after 2.0.16 to fix Xwayland regressions, and after 2.0.18 to fix event loop regressions. For development releases, this gives us the ability to make multiple prereleases during the same feature cycle, and distinguish between them programmatically. For example, this would have been useful during 2.0.22 development, which went through three prereleases before reaching the final release. Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 14:16:11 +00:00			`* Do the release`

			`## After a feature release`

			* Create a branch like `release-2.24.x`

			`* Bump version number to 2.ODD.0 for next development branch`

build-scripts: Added update-version.sh Fixes #6171. 2022-09-28 02:03:26 +00:00			* `./build-scripts/update-version.sh 2 ODD 0`
workflows: Add a test to assert that all the version numbers agree Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-04 15:43:59 +00:00
Switch versioning scheme to be the same as GLib and Flatpak For stable releases, this gives us the ability to make bugfix-only point releases such as 2.24.1 if we want to, and distinguish between them programmatically. For example, this ability could have been useful after 2.0.16 to fix Xwayland regressions, and after 2.0.18 to fix event loop regressions. For development releases, this gives us the ability to make multiple prereleases during the same feature cycle, and distinguish between them programmatically. For example, this would have been useful during 2.0.22 development, which went through three prereleases before reaching the final release. Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 14:16:11 +00:00			`## New development prerelease`

			`* Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is odd)`
docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 13:09:12 +00:00
build-scripts: Added update-version.sh Fixes #6171. 2022-09-28 02:03:26 +00:00			* `./build-scripts/update-version.sh 2 Y Z+1`
Note that we should regenerate configure before running test/versioning.sh 2022-09-05 18:25:10 +00:00
Switch versioning scheme to be the same as GLib and Flatpak For stable releases, this gives us the ability to make bugfix-only point releases such as 2.24.1 if we want to, and distinguish between them programmatically. For example, this ability could have been useful after 2.0.16 to fix Xwayland regressions, and after 2.0.18 to fix event loop regressions. For development releases, this gives us the ability to make multiple prereleases during the same feature cycle, and distinguish between them programmatically. For example, this would have been useful during 2.0.22 development, which went through three prereleases before reaching the final release. Signed-off-by: Simon McVittie <smcv@collabora.com> 2022-05-03 14:16:11 +00:00			`* Do the release`