-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create Pre-Release Issue Template (#2059)
- Loading branch information
Showing
1 changed file
with
86 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<!-- Make sure any high priority bugs which are found during smoke testing are resolved --> | ||
- [ ] [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 | ||
<!-- Update version references to version [**VERSION**] in the following locations (Update versions within `docs/release_notes/index.rst` as a separate PR updating release notes - See "Update Release Notes PR"). --> | ||
|
||
**PR:** | ||
- [ ] `CITATION.cff` | ||
- Version: `version: "V.V.V"` | ||
- Release Date: `date-released: YYYY-MM-DD` | ||
- [ ] `docs/_templates/versioning.html` | ||
- Version: Under `<h3>{{ _('Versions') }}</h3>` | ||
- [ ] `docs/conf.py` | ||
- Release Date: | ||
- Version: `release = 'V.V.V<tag>'` (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) | ||
<!-- Make sure list of authors remains in alphabetical order by surname --> | ||
|
||
**PR:** | ||
- [ ] `CITATION.cff` | ||
- [ ] `docs/conf.py` | ||
- [ ] `docs/index.rst` | ||
|
||
|
||
## Release Notes PR | ||
<!-- Update release notes for new version and format "next" release notes --> | ||
|
||
**PR:** | ||
- [ ] Compile Release Notes using the following command `python setup.py release_notes` - Copy output and place in new file `docs/release_notes/<V.V.rst>` | ||
- [ ] 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 | ||
<!-- Add any additional information below related to the release which may be useful t ou or the reviewer --> | ||
|
||
|