mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SDL/docs/release_checklist.md

50 lines
1.1 KiB
Markdown
Raw Normal View History

docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com>
2022-05-03 16:09:12 +03:00
# Release checklist
Moved test/versioning.sh to build-scripts/test-versioning.sh Reference Issue #6171.
2022-09-28 16:09:21 +03: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
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
`3 8 1` means "change the version to 3.8.1". This script does much of the
Moved test/versioning.sh to build-scripts/test-versioning.sh Reference Issue #6171.
2022-09-28 16:09:21 +03:00
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 17:16:11 +03: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 16:09:12 +03:00
* Update `WhatsNew.txt`
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* Bump version number to 3.EVEN.0:
docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com>
2022-05-03 16:09:12 +03:00
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* `./build-scripts/update-version.sh 3 EVEN 0`
Note that we should regenerate configure before running test/versioning.sh
2022-09-05 21:25:10 +03:00
docs/release_checklist.md: Document how/where to bump version numbers Signed-off-by: Simon McVittie <smcv@collabora.com>
2022-05-03 16:09:12 +03:00
* Do the release
Added a note to update the website after a stable release
2022-10-08 19:41:10 +03:00
* Update the website file include/header.inc.php to reflect the new version
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 17:16:11 +03:00
## New bugfix release
* Check that no new API/ABI was added
* If it was, do a new feature release (see above) instead
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* Bump version number from 3.Y.Z to 3.Y.(Z+1) (Y is even)
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 17:16:11 +03:00
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* `./build-scripts/update-version.sh 3 Y Z+1`
Note that we should regenerate configure before running test/versioning.sh
2022-09-05 21:25:10 +03: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 17:16:11 +03:00
* Do the release
Added a note to update the website after a stable release
2022-10-08 19:41:10 +03:00
* Update the website file include/header.inc.php to reflect the new version
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 17:16:11 +03:00
## After a feature release
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* Create a branch like `release-3.4.x`
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 17:16:11 +03:00
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* Bump version number to 3.ODD.0 for next development branch
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 17:16:11 +03:00
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* `./build-scripts/update-version.sh 3 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 18:43:59 +03: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 17:16:11 +03:00
## New development prerelease
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* Bump version number from 3.Y.Z to 3.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 16:09:12 +03:00
Updated release_checklist.md for SDL 3.0
2023-01-05 10:47:01 +03:00
* `./build-scripts/update-version.sh 3 Y Z+1`
Note that we should regenerate configure before running test/versioning.sh
2022-09-05 21:25:10 +03: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 17:16:11 +03:00
* Do the release