search

OpenFreeEnergy / openfe

The Open Free Energy toolkit
https://docs.openfree.energy
MIT License
141 stars 20 forks source link

Create release checklist #623

Closed mikemhenry closed 6 days ago

mikemhenry commented 1 year ago

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 commented 8 months ago

Ensure we have branch protection rules for release/*

IAlibay commented 8 months ago

Key stakeholders:

mikemhenry commented 8 months ago

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

IAlibay commented 8 months ago

TODO:

mikemhenry commented 8 months ago

TODO

IAlibay commented 3 weeks ago

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