From a8ec9228d4c36bea2507e98794b2f2ec93bea2b1 Mon Sep 17 00:00:00 2001 From: Rangi42 Date: Tue, 10 Dec 2024 13:06:58 -0500 Subject: [PATCH] List post-release steps to take for other gbdev projects --- RELEASE.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 95fe8db5..45fa6a78 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -5,11 +5,13 @@ GitHub. 1. Update the following files, then commit and push. You can use git commit -m "Release <version>" and `git push origin master`. - - - [include/version.hpp](include/version.hpp): set appropriate values for `PACKAGE_VERSION_MAJOR`, `PACKAGE_VERSION_MINOR`, `PACKAGE_VERSION_PATCH`, and `PACKAGE_VERSION_RC` + + - [include/version.hpp](include/version.hpp): set appropriate values for `PACKAGE_VERSION_MAJOR`, + `PACKAGE_VERSION_MINOR`, `PACKAGE_VERSION_PATCH`, and `PACKAGE_VERSION_RC`. **Only** define `PACKAGE_VERSION_RC` if you are publishing a release candidate! - [Dockerfile](Dockerfile): update `ARG version`. - - [test/fetch-test-deps.sh](test/fetch-test-deps.sh): update test dependency commits (preferably, use the latest available). + - [test/fetch-test-deps.sh](test/fetch-test-deps.sh): update test dependency commits + (preferably, use the latest available). - [man/\*](man/): update dates and authors. 2. Create a Git tag formatted as v<MAJOR>.<MINOR>.<PATCH>, @@ -67,3 +69,12 @@ GitHub. 6. Click the "Publish release" button to publish it! 7. Update the `release` branch. You can use `git push origin release`. + +8. Update the following related projects. + + - [rgbobj](https://github.com/gbdev/rgbobj) and [rgbds-obj](https://github.com/gbdev/rgbds-obj): + make sure that object files created by the latest RGBASM can be parsed and displayed. + If the object file revision has been updated, rgbobj will need a corresponding release. + - [rgbds-www](https://github.com/gbdev/rgbds-www): update + [src/pages/versions.mdx](https://github.com/gbdev/rgbds-www/blob/master/src/pages/versions.mdx) + to list the new release.