From 7fdaf447c71a938568e85e7e1ea868ade39467fb Mon Sep 17 00:00:00 2001 From: Jaka Kranjc <lynxlupodian@users.sourceforge.net> Date: Fri, 30 Aug 2019 17:59:01 +0200 Subject: [PATCH] added release checklist template --- CONTRIBUTING.md | 2 ++ admin/github_release.checklist | 36 ++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 admin/github_release.checklist diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f04356cc08..32e705f502 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,6 +162,8 @@ All of this makes reviewing and bisecting for regressions easier. 1. Squash merge only if the history is a mess or it makes more sense (eg. consecutive commits through the github website). 2. For release planning check the milestones and gemrb/docs/Release.txt. +2.1. When starting the final approach, use `admin/github_release.checklist` +as a template to track progress in a dedicated issue. 3. Releases are usually made when larger pieces of work land or many smaller fixes have accrued. 4. Versioning is semantic, but also ad-hoc. We want 1.0 to be the classic diff --git a/admin/github_release.checklist b/admin/github_release.checklist new file mode 100644 index 0000000000..bd53a7cebb --- /dev/null +++ b/admin/github_release.checklist @@ -0,0 +1,36 @@ +### Release checklist + +This is a general release preparation checklist. See [Release.md](gemrb/docs/en/Release.md) for a longer writeup. + +Final development: +- [ ] Fix or postpone issues in the [milestone](https://github.com/gemrb/gemrb/milestones) +- [ ] Triage open pull requests +- [ ] Check local stashes + +Beta testing: +- [ ] Playthrough: Chateau Irenicus to Waukeen's promenade +- [ ] Playthrough: TOB up to Saradush +- [ ] Ideally a full game runthrough of one of the compleatable games +- [ ] Retest character generation of remaining games + +Release: +- [ ] Finalise choice of version number +- [ ] Update both version numbers +- [ ] Final `NEWS` update +- [ ] Write docs: + - [ ] Forum announcements + - [ ] Release notes +- [ ] `make dist` +- [ ] Add a git tag and push it +- [ ] Run `admin/guidoc_wikifier.sh` (no params needed) and upload the new docs +- [ ] Promote the new tag to a release on GitHub +- [ ] Update versions back to `-git` suffix +- [ ] `admin/restart_news.sh` +- [ ] SourceForge + - [ ] Upload source package to SourceForge + - [ ] Upload any release notes alongside + - [ ] Mark release's AppVeyor build as a Windows default on SourceForge + - [ ] (optional) regenerate android build + - [ ] Test downloads +- [ ] Runtime tests of release packages +- [ ] Announce as per Release.md -- GitLab