diff --git a/RELEASE.md b/RELEASE.md index cbbf6e4fb..c2d72e405 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -3,13 +3,14 @@ This describes for the maintainers of RGBDS how to publish a new release on GitHub. -1. Update, commit, and push [include/version.hpp](include/version.hpp) with - values for `PACKAGE_VERSION_MAJOR`, `PACKAGE_VERSION_MINOR`, - `PACKAGE_VERSION_PATCH`, and `PACKAGE_VERSION_RC`, as well as - [Dockerfile](Dockerfile) with a value for `ARG version`. Only define - `PACKAGE_VERSION_RC` if you are publishing a release candidate! You can - use git commit -m "Release <version>" and - `git push origin master`. +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` + **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). + - [man/\*](man/): update dates and authors. 2. Create a Git tag formatted as v<MAJOR>.<MINOR>.<PATCH>, or v<MAJOR>.<MINOR>.<PATCH>-rc<RC>