Skip to content

Commit

Permalink
Merge pull request #30 from The-Strategy-Unit/release-qa-checklist
Browse files Browse the repository at this point in the history
Create issue template for release checklist
  • Loading branch information
yiwen-h authored Jun 4, 2024
2 parents 3e3c856 + 6715c0d commit 17e5069
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/release-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
name: Release Checklist
about: Captures all Quality Assurance steps taken when releasing a new version of
the model, inputs, and outputs apps
title: Release Checklist v.[X.X]
labels: qa
assignees: ''

---

We have three types of releases: major, minor and patch following semantic versioning. Major releases must meet criteria for patch, minor and major. Minor releases must meet criteria for patch and minor.

We:

- name Git tags and release titles in the form 'v1.2.3'
- typically use the 'generate release notes' button in GitHub to autofill the release description
- add update notes to the 'model updates' page of the NHP model project information site
- communicate all changes to key stakeholders and end users via the Model Relationship Manager system.


# Patch

## Data
Patch releases should not involve changes to data.

## Inputs
- [ ] Scenarios can be created from scratch
- [ ] New scenarios can be created from existing
- [ ] Existing scenarios can be edited
- [ ] If text for inputs has been updated, also update project_information

## End-to-end test
Patch releases should not involve changes to end-to-end process.

## Model
- [ ] Model can be run locally on synthetic data

## Outputs
- [ ] Able to load and view results for a model run
- [ ] Click on all tabs and check figures show on all tabs

# Minor
- [ ] 100% test coverage for all repos
- [ ] Update posted on project_information site

## Data
- [ ] Has been copied to Azure into v.X.Y.Z
- [ ] Changes have been recorded in data log

## Inputs
- [ ] GH Actions variables updated to vX.Y.Z
- [ ] New version number added to inputs selection app dropdown
- [ ] Start model run

## End-to-end test
- [ ] Check model run submitted from inputs app completes and scenario results are viewable on Outputs

## Model
- [ ] GH Actions variables updated to vX.Y.Z
- [ ] Run at least 2 random scenarios from previous release and check results are similar to previous release.

## Outputs
- [ ] Download results of new model scenario in Excel format

# Major
- [ ] User testing conducted

0 comments on commit 17e5069

Please sign in to comment.