openfe icon indicating copy to clipboard operation
openfe copied to clipboard

Published 20 hours ago • verified publisher icon OpenFreeEnergy

Create release checklist

Open mikemhenry opened this issue 2 years ago • 5 comments

Should document:

  1. Decide to create release (collaborate with upstream and downstream) and ensure no api breaks (unless major) (decide if an RC is needed)
  2. Make upcoming release announcement to key stakeholders
  3. Create branch from main called release/version ie release/0.89.3
  4. Test the branch, if changes are needed, make PR into the branch
  5. After branch is validated, create release notes and add deprecation warnings if needed
  6. create tag
  7. evaluate conda-forge pins
  8. release branch on conda-forge, make single file installer(s), make docker and apptainer images
  9. merge branch back into main (or cheery pick), deal with merge conflicts so post merge we have something that works
  10. Make announcement to the world

mikemhenry avatar Nov 14 '23 23:11 mikemhenry

Ensure we have branch protection rules for release/*

mikemhenry avatar Mar 19 '24 15:03 mikemhenry

Key stakeholders:

  • OpenFE internal team
  • OpenFE board
  • OpenFE developers (e.g. FEFlow)
  • OpenFE direct users / collaborators
  • OMSF
  • OpenFF
  • Alchemiscale
  • ASAP
  • General community (linkedin, etc...)

IAlibay avatar Mar 19 '24 15:03 IAlibay

Make cannery CI workflows for key downstream (alchemiscale, feflow)

mikemhenry avatar Mar 19 '24 15:03 mikemhenry

TODO:

  • [ ] Document - where does this checklist live?
  • [ ] Define what testing the branch means

IAlibay avatar Mar 19 '24 15:03 IAlibay

TODO

  • [ ] Make PR to add this to docs
  • [ ] Migrate how to cut release from wiki

mikemhenry avatar Mar 19 '24 15:03 mikemhenry

If we're making a minor release this sprint, we should try to get this written somewhere.

IAlibay avatar Oct 28 '24 12:10 IAlibay