ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Release checklist (markdown)

James Groom 2022-12-13 09:39:19 +10:00
parent c911938151
commit 80a6eeecba
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Release-checklist.md

@ -4,8 +4,8 @@ Note that some of these can be done concurrently.
- Ideally there would be a release candidate and rigorous testing, but there never seems to be enough time...
1. Test Issues labelled "Patch pending"
1. Write the changelog
- 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.
- 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. TODO write a bespoke tool for editing changelog
- 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 unless no Issue exists.
- 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).
- 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.
@ -39,6 +39,8 @@ Note that some of these can be done concurrently.
- TASVideos news, Discord, etc.
### Changelog structure
(see "Write the changelog" above)
Treat Libretro as just another core in this context.
The cores under "Other cores:" are in alphabetical order, new/graduating aren't.
The changes should be sorted with the most important first, but that's kinda subjective so don't try too hard.