Skip to content

Commit

Permalink
Added a note about the GitHub tag
Browse files Browse the repository at this point in the history
  • Loading branch information
muffato committed Apr 17, 2024
1 parent fff5606 commit 8242831
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions markdown/developers/pipeline-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Follow the "Before you release" and "Steps to release" from the [nf-core release
About version numbers and release names:

1. The release _number_ is made of digits and dots **only**, and follows [Semantic Versioning](https://semver.org/).
It is used as the git _tag_ too.
2. The release _name_ is whatever you want. It can be Harry Potter, Stargate, or Pokemon. Express your creativity! You only need a new name for major and minor releases. Patch releases reuse the last name with the addition of `(patch ${PATCH_NUMBER})`.
3. The release _title_ you enter on GitHub must be of the form `v${RELEASE_NUMBER} - ${RELEASE_NAME}`. No need to include the pipeline name there, especially as it is added by Zenodo later.
4. The release _description_ you enter on GitHub should be the same from what you have in the Changelog, e.g.:
Expand Down

0 comments on commit 8242831

Please sign in to comment.