diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md new file mode 100644 index 00000000000..7cd5dd59bd7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release.md @@ -0,0 +1,86 @@ +--- + +name: Pre-Release Issue Template for Developers +about: For Developers Only - Should be used when Preparing for a release to make sure no tasks are missed during the build-up for a release +title: 'FOR DEVELOPERS: Mantid Imaging [V.V.V] Pre-Release' +labels: 'Release 🚀' +assignees: '' + +--- + +## Description + +As part of preparations for the release of Mantid Imaging version [**VERSION***], the following tasks need to be completed. + + +## High Priority Bugs + +- [ ] [High priority bugs](https://github.com/mantidproject/mantidimaging/issues?) + + +## Create release branch +- [ ] Create branch from main named release-x.x.x +- [ ] Check that branch protection rules are being applied + + +## Version Update PR + + +**PR:** +- [ ] `CITATION.cff` + - Version: `version: "V.V.V"` + - Release Date: `date-released: YYYY-MM-DD` +- [ ] `docs/_templates/versioning.html` + - Version: Under `

{{ _('Versions') }}

` +- [ ] `docs/conf.py` + - Release Date: + - Version: `release = 'V.V.V'` (alpha/beta/rc) + - Version: `smv_tag_whitelist = r'^(2.3.0|2.4.0|2.5.0|2.6.0|2.7.0)$'` +- [ ] `docs/index.rst` + - Year: update year within Citation if out of date + - Version: update version within Citation + + +## Authors PR (if required) + + +**PR:** +- [ ] `CITATION.cff` +- [ ] `docs/conf.py` +- [ ] `docs/index.rst` + + +## Release Notes PR + + +**PR:** +- [ ] Compile Release Notes using the following command `python setup.py release_notes` - Copy output and place in new file `docs/release_notes/` +- [ ] Add newest version under "next": `docs/release_notes/index.rst` +- [ ] Delete all release notes within: `docs/release_notes/next/` + + +## Create Release + +- [ ] Create release from tag (See internal docs for how to do this) + + +## Move IDAaas to Stable Branch + +- [ ] IDAaaS - move stable branch (See internal docs for how to do this) + + +## Update Versions on Main + +- [ ] Versions on main + - Tag commit as alpha for next release (e.g. after releasing V.V) + - Once merged checkout main and run `git describe ` to check if the tag is part of the history (See internal docs for additional info) + + +## Windows NSIS Installer + - [ ] Build Windows NSIS Installer (See internal docs for how to do this) + + +### Additional Info + + +