diff --git a/Release-checklist.md b/Release-checklist.md index a3c2894..6f3ddcf 100644 --- a/Release-checklist.md +++ b/Release-checklist.md @@ -7,7 +7,7 @@ Note that some of these can be done concurrently. - You can use `git log --pretty='format:[%h %an] %s%n%b%n' 2.x..` (substitute the last release tag for "2.x") as a starting point. - After parsing through the commits to get a list of user-facing changes, group them as in the example below. Use past tense. You should include Issue numbers for bugs and feature requests, but not PRs. - This needs to be prepended to `/Assets/changelog.md` (Markdown) *immediately before* updating the `release` branch so that it ends up in the build artifacts. - - It also needs to be prepended to [the `ReleaseHistory` article](https://tasvideos.org/Bizhawk/ReleaseHistory) (TASVideos wiki markup). Apart from changing markup language, also remember to include download links and the release date (will need to finish this after publishing). + - It also needs to be prepended to [the `ReleaseHistory` article](https://tasvideos.org/Bizhawk/ReleaseHistory) (TASVideos Wiki markup). Apart from changing markup language, also remember to include download links and the release date (will need to finish this after publishing). - There's also [the ext. tool changelog](https://github.com/TASEmulators/BizHawk-ExternalTools/wiki/Partial-changelog-for-ApiHawk). If an ApiHawk change doesn't affect Lua then it might not warrant inclusion on the main changelog, but this one includes even the tiny method signature changes. 1. Update `VersionInfo.MainVersion` if it was set for a point release but this will be a minor release 1. Update the `release` branch to point to `master` @@ -31,8 +31,9 @@ Note that some of these can be done concurrently. - Re-triage Issues which were only reproduced on dev builds ("Repro: Affects 2.x.1 dev"), and Issues which affected cores that were updated in this release. 1. Update `VersionInfo.MainVersion` and `VersionInfo.ReleaseDate` - `ReleaseDate` is overwritten by CI for release builds, but needs to be checked-in. `MainVersion` should be set to e.g. `"2.x.2"` after releasing 2.x.1. -1. Update readme - - The version isn't explicitly written in any links or text, but the information itself might become outdated, especially the core list. +1. Update readme and other documentation pages + - The version isn't explicitly written in any links or text in the readme, but the information itself might become outdated, especially the core list. + - [LuaFunctions on TASVideos Wiki](https://tasvideos.org/BizHawk/LuaFunctions) 1. Nix stuff? 1. Hype - TASVideos news, Discord, etc.