mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-05 19:08:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: explain build-scripts/create-release.py in the release checklist

Browse Source
This commit is contained in:
Anonymous Maarten
2024-10-16 03:40:26 +02:00
committed by Anonymous Maarten
parent 18410c03ea
commit 69433ee075
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/release_checklist.md
View File

@@ -1,9 +1,15 @@
# 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
`3 8 1` means "change the version to 3.8.1". This script does much of the
mechanical work.
* Run `build-scripts/create-release.py -R libsdl-org/SDL --ref <git-ref>` to command
GitHub Actions to start creating release assets.
It's advisable to run this script regularly, and also prior to any release step.
When creating the release assets, `<git-ref>` must be the release tag
This makes sure the revision string baked into the archives is correct.
* 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
`3 8 1` means "change the version to 3.8.1". This script does much of the
mechanical work.
## New feature release