Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release: 5.3.1 #2383

Closed
13 of 18 tasks
jemrobinson opened this issue Jan 27, 2025 · 0 comments · Fixed by #2390
Closed
13 of 18 tasks

Release: 5.3.1 #2383

jemrobinson opened this issue Jan 27, 2025 · 0 comments · Fixed by #2390
Labels
release candidate This is a candidate for release

Comments

@jemrobinson
Copy link
Member

jemrobinson commented Jan 27, 2025

✅ Checklist

Refer to the 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
    • If this is a hotfix release then this branch should be based off latest
    • In all other cases it should be based off develop
  • Draft a changelog for the release similar to our previous releases

For patch releases only

  • Confirm that the resource to which the patch applies can be successfully deployed

For minor releases and above

  • Deploy an SHM from this branch and save a transcript of the deployment logs
  • Deploy a tier 2 SRE from this branch and save the transcript of the deployment logs
  • Deploy a tier 3 SRE from this branch and save the transcript of the deployment logs
  • Complete the Security evaluation checklist from the deployment documentation

For major releases only

  • Confirm that a third party has carried out a full penetration test evaluating:
    1. external attack surface
    2. ability to exfiltrate data from the system
    3. ability to transfer data between SREs
    4. ability to escalate privileges on the SRD.

Update documentation

  • Update supported versions in SECURITY.md
  • Update pen test results in VERSIONING.md

Making the release

  • Merge release branch into latest
  • Create a tag of the form v0.0.1 pointing to the most recent commit on latest (the merge that you just made)
  • Publish your draft GitHub release using this tag
  • Ensure docs for the latest version are built and deployed on ReadTheDocs
  • Push a build to PyPI
  • Announce release on communications channels
  • Create a PR from latest into develop to ensure that release-specific changes are not lost

🌳 Deployment problems

@jemrobinson jemrobinson added the release candidate This is a candidate for release label Jan 27, 2025
This was referenced Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release candidate This is a candidate for release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant