Merge pull request #1543 from edwardchalstrey1/release-checklist

Release checklist GH issue template

.github/ISSUE_TEMPLATE/release_checklist.md

@@ -0,0 +1,47 @@
+---
+name: Release checklist
+about: Log completion of required actions for release testing
+title: "Release: <version number>"
+labels: "type: release-candidate"
+assignees: ""
+---
+
+## :white_check_mark: Checklist
+
+<!--
+Before reporting a problem please check the following. Replace the empty checkboxes [ ] below with checked ones [x] accordingly.
+-->
+
+Refer to the [Deployment](https://data-safe-haven.readthedocs.io/en/latest/deployment) section of our documentation when completing these steps.
+
+- [ ] Consult the `data-safe-haven/VERSIONING.md` guide and determine the version number of the new release. Record it in the title of this issue.
+- [ ] Create a release branch called e.g. `release-v0.0.1`
+- [ ] Draft a changelog for the release similar to our previous releases, see https://github.com/alan-turing-institute/data-safe-haven/releases
+- [ ] Deploy an SHM from this branch and save a transcript of the deployment logs
+- [ ] Build an SRE compute image (SRD) and save transcripts of the logs
+- Using the new image, deploy two SREs which between them cover tiers 2 and 3 and Guacamole/Microsoft RDS
+    - [ ] Save the transcript of your tier 2 SRE deployment
+    - [ ] Save the transcript of your tier 3 SRE deployment
+- [ ] Complete the [Security evaluation checklist](https://data-safe-haven.readthedocs.io/en/latest/deployment/security_checklist.html) from the deployment documentation
+
+**For MAJOR releases:**
+
+- [ ] Confirm that a third party has carried out a full penetration test evaluating:
+  1. external attack surface
+  1. ability to exfiltrate data from the system
+  1. ability to transfer data between SREs
+  1. ability to escalate privileges on the SRD.
+
+## :computer: Release information
+
+- **Version number:** _
+- **SHM ID:** _
+- **T2 SRE ID:** _
+- **T3 SRE ID:** _
+
+## :deciduous_tree: Deployment problems
+
+<!--
+Keep a record in this issue of problems and fixes implemented during the release process. Be sure to update the changelog if any new commits are added to the release branch.
+-->
+

README.md

@@ -41,6 +41,8 @@ Follow the link from any release to view and clone this repository as at that re
 
 Read our [versioning scheme](VERSIONING.md) for how we number and label releases, as well as details of releases that have been used in production and releases that have undergone formal security evaluation.
 
+When making a new release, open an issue on GitHub and choose the `Release checklist` template, which can be used to track the completion of security checks for the release.
+
 ## :mailbox_with_mail: Vulnerability disclosure
 
 We value those who take the time and effort to report security vulnerabilities.