Skip to content

Commit

Permalink
Merge pull request #577 from maxulysse/dev_release_checklist
Browse files Browse the repository at this point in the history
update RELEASE_CHECKLIST
  • Loading branch information
maxulysse authored Jul 1, 2022
2 parents 340f813 + 3a919c6 commit 4a3784c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 15 deletions.
24 changes: 9 additions & 15 deletions .github/RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,16 @@
1. Check that everything is ready to go
- Desired [PRs](https://github.com/nf-core/sarek/pulls) are merged
- [GitHub Actions](https://github.com/nf-core/sarek/actions?query=workflow%3A%22nf-core+CI%22) are passing on `dev`
- [nf-core linting](https://github.com/nf-core/sarek/actions?query=workflow%3A%22nf-core+linting%22) are passing on `dev`
- [GHA CI](https://github.com/nf-core/sarek/actions/workflows/ci.yml) are passing on `dev`
- [GHA linting](https://github.com/nf-core/sarek/actions/workflows/linting.yml) are passing on `dev`
2. Increase version number following [semantic versioning](http://semver.org/spec/v2.0.0.html)
3. Choose an appropriate codename for the release (if major or minor)
- i.e. Peaks in [Sarek National Park](https://en.wikipedia.org/wiki/Sarek_National_Park#Topography)
4. Sync `dev` and checkout a new branch for the release
5. Bump version:
- `nf-core bump-version . <VERSION>`
- edit `.circleci/config.yml`
- edit `.github/workflows/ci.yml`
- edit `conf/base.config`
- edit `conf/test.config`
- edit `containers/snpeff/Dockerfile`
- edit `containers/snpeff/environment.yml`
- edit `containers/vep/Dockerfile`
- edit `containers/vep/environment.yml`
- 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`
Expand All @@ -33,13 +27,13 @@
13. Checkout the `CHANGELOG.md` from `master`
- `git checkout upstream/master -- CHANGELOG.md`
14. Add a new `Unreleased` section in `CHANGELOG.md` for the `dev` version
15. Checkout `docs/images/sarek_workflow.svg` and `docs/images/sarek_workflow.pnh` from `master`
15. Checkout figures from `master`
- `git checkout upstream/master -- docs/images/sarek_subway.svg`
- `git checkout upstream/master -- docs/images/sarek_subway.png`
- `git checkout upstream/master -- docs/images/sarek_workflow.svg`
- `git checkout upstream/master -- docs/images/sarek_workflow.png`
16. Make a PR to `dev`
17. Wait for review
18. Merge said PR
19. Download all new containers to `/sw/data/uppnex/ToolBox/nf-core` on `rackham`
20. Download newest `nf-core/sarek` to `/data1/containers` on `munin`
21. Commit and push. Continue making more awesome :metal:
22. Have fika :cake:
19. Commit and push. Continue making more awesome :metal:
20. Have fika :cake:
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#570](https://github.com/nf-core/sarek/pull/570) - Extract mpileup into its own subworkflow; zip mpileup files
- [#571](https://github.com/nf-core/sarek/pull/571) - Including and using GATK4's mergeVcfs
- [#572](https://github.com/nf-core/sarek/pull/572) - Adjusted subway map svg for firefox compatibility
- [#577](https://github.com/nf-core/sarek/pull/577) - Update `RELEASE_CHECKLIST`
- [#578](https://github.com/nf-core/sarek/pull/578) - Updated module deeptools/bamcoverage
- [#585](https://github.com/nf-core/sarek/pull/585) - Remove explicit BAM to CRAM conversion after MarkduplicatesSpark; tool does it internally
- [#581](https://github.com/nf-core/sarek/pull/581) - `TIDDIT` is updated to `3.1.0`
Expand Down

0 comments on commit 4a3784c

Please sign in to comment.