From 69433ee075400b661bd1488f61a196575d9c5526 Mon Sep 17 00:00:00 2001
From: Anonymous Maarten <[EMAIL REDACTED]>
Date: Wed, 16 Oct 2024 03:40:26 +0200
Subject: [PATCH] doc: explain build-scripts/create-release.py in the release
checklist
---
docs/release_checklist.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/docs/release_checklist.md b/docs/release_checklist.md
index b1d66f49ef164..7f7629447848d 100644
--- a/docs/release_checklist.md
+++ b/docs/release_checklist.md
@@ -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