Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
25 lines (22 loc) · 2.38 KB

RELEASE_CHECKLIST.md

File metadata and controls

25 lines (22 loc) · 2.38 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 pyproject.toml.
  6. Make sure all CI tests are passing!
  7. Create a PR from dev to main
  8. Run a manual sync on nf-core/testpipeline and check that CI is passing on the resulting PR: use the Sync template GitHub Action from the tools repository specifying the pipeline name and running from the dev branch.
  9. Warn someone from Seqera to make sure that the Seqera Platform is working as expected with the new template: use the nf-core/testpipeline new branch with the template updates.
  10. Make sure all CI tests are passing again (additional tests are run on PRs to main)
  11. Request review (2 approvals required)
  12. Merge the PR into main
  13. Wait for CI tests on the commit to passed
  14. Create a new release copying the CHANGELOG for that release into the description section.

After release

  1. Run the Sync template GitHub Action to trigger the template update PR to some selected pipelines (sarek, createtaxdb, proteinfold, mag, #team-maintainers channel) and ask the pipeline maintainers to make the update and report any issues/comments.
  2. Run rich-codex to regenerate docs screengrabs: Generate images for docs GitHub Action on the tools/website repo.
  3. Manually trigger the Sync template GitHub Action for all pipelines.
  4. Check that the automatic PyPi deployment has worked: pypi.org/project/nf-core
  5. Check BioConda has an automated PR to bump the version, and merge. eg. bioconda/bioconda-recipes #20065
  6. Create a tools PR to dev to bump back to the next development version in CHANGELOG.md and pyproject.toml.