Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 2 KB

RELEASE_CHECKLIST.md

File metadata and controls

23 lines (20 loc) · 2 KB

Before release

  1. Check issue milestones to see outstanding issues to resolve if possible or transfer to the milestones for the next release e.g. v1.9
  2. Most importantly, pick an undeniably outstanding name for the release where Prefix = Metal and Dictionary = Animal.
  3. Check the pipeline health page to make sure that all repos look sane (missing TEMPLATE branches etc)
  4. Check that modules/subworkflows in template are up to date with the latest releases
  5. Create a PR to dev to bump the version in CHANGELOG.md and setup.py and change the gitpod container to nfcore/gitpod:latest.
  6. Make sure all CI tests are passing!
  7. Create a PR from dev to master
  8. Make sure all CI tests are passing again (additional tests are run on PRs to master)
  9. Request review (2 approvals required)
  10. Run rich-codex to regenerate docs screengrabs (actions workflow_dispatch button)
  11. Merge the PR into master
  12. Wait for CI tests on the commit to passed
  13. (Optional but a good idea) Run a manual sync on nf-core/testpipeline and check that CI is passing on the resulting PR.
  14. Create a new release copying the CHANGELOG for that release into the description section.

After release

  1. Check the automated template synchronisation has been triggered properly. This should automatically open PRs directly to individual pipeline repos with the appropriate changes to update the pipeline template.
  2. Check that the automatic PyPi deployment has worked: pypi.org/project/nf-core
  3. Check BioConda has an automated PR to bump the version, and merge. eg. bioconda/bioconda-recipes #20065
  4. Create a tools PR to dev to bump back to the next development version in CHANGELOG.md and setup.py and change the gitpod container to nfcore/gitpod:dev.