This checklist is for our own reference, to help us prepare a new release
- Check that everything is ready to go
- Desired PRs are merged
- GHA CI are passing on
dev - GHA linting are passing on
dev
- Increase version number following semantic versioning
- Choose an appropriate codename for the release (if major or minor)
- i.e. Peaks in Sarek National Park
- Sync
devand checkout a new branch for the release - Bump version:
nf-core bump-version . <VERSION>- edit
docs/images/sarek_subway.svg - generate a new
docs/images/sarek_subway.png - edit
docs/images/sarek_workflow.svg - generate a new
docs/images/sarek_workflow.png - edit
CHANGELOG
- Make a PR to
master - Wait for reviews
- Merge said PR
- Make a release on GitHub
- Update bio.tools with the new release details
- RT the nf-core automated tweet about the new released version
- Make a new branch from
dev - Checkout the
CHANGELOG.mdfrommastergit checkout upstream/master -- CHANGELOG.md
- Add a new
Unreleasedsection inCHANGELOG.mdfor thedevversion - Checkout figures from
mastergit checkout upstream/master -- docs/images/sarek_subway.svggit checkout upstream/master -- docs/images/sarek_subway.pnggit checkout upstream/master -- docs/images/sarek_workflow.svggit checkout upstream/master -- docs/images/sarek_workflow.png
- Make a PR to
dev - Wait for review
- Merge said PR
- Commit and push. Continue making more awesome 🤘
- Have fika 🍰