[docs-v2]: transfer pipeline release checklist #3745
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for nf-core-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
❌ Deploy Preview for nf-core-main-site failed. Why did it fail? →
|
Member
Author
|
Direct link to new page: https://deploy-preview-3745--nf-core-docs.netlify.app/docs/developing/pipelines/release-procedure |
| title: Release procedure | ||
| subtitle: A step-by-step guide for releasing a nf-core pipeline | ||
| markdownPlugin: checklist | ||
| weight: 10 |
Member
There was a problem hiding this comment.
Suggested change
| weight: 10 |
I have these sorted as alphabetical order for now.
| ## Before you release | ||
|
|
||
| :::warning | ||
| If this is your first release, make sure to follow the [first release tutorial](/docs/contributing/contribute-new-pipelines#make-the-first-release) for extra review requirements! |
Member
There was a problem hiding this comment.
Suggested change
| If this is your first release, make sure to follow the [first release tutorial](/docs/contributing/contribute-new-pipelines#make-the-first-release) for extra review requirements! | |
| If this is your first release, follow the [first release guide](/docs/contributing/contribute-new-pipelines#make-the-first-release) for extra review requirements |
|
|
||
| - [ ] Check on the issues tab of GitHub repository that there are no outstanding bug reports that should be resolved. | ||
| - [ ] If you have a [release milestone](https://help.github.com/en/github/managing-your-work-on-github/about-milestones), check all planned functionality and improvements are addressed. | ||
| - It's fine to decide that some things should be postponed until the next release. Move them on to the next milestone |
Member
There was a problem hiding this comment.
Can this be an admonition? The points are action verbs and more details as a subpoint can be confusing
| - [ ] If you have a [release milestone](https://help.github.com/en/github/managing-your-work-on-github/about-milestones), check all planned functionality and improvements are addressed. | ||
| - It's fine to decide that some things should be postponed until the next release. Move them on to the next milestone | ||
| - [ ] Check the pipeline follows [nf-core guidelines](/docs/specifications/pipelines/overview) and [nf-core pipeline release review guidelines](/docs/contributing/reviewing-pull-requests/review_checklists/pipeline-release). | ||
| - This is what reviewers will be checking against. |
Member
There was a problem hiding this comment.
Suggested change
| - This is what reviewers will be checking against. |
| - It's fine to decide that some things should be postponed until the next release. Move them on to the next milestone | ||
| - [ ] Check the pipeline follows [nf-core guidelines](/docs/specifications/pipelines/overview) and [nf-core pipeline release review guidelines](/docs/contributing/reviewing-pull-requests/review_checklists/pipeline-release). | ||
| - This is what reviewers will be checking against. | ||
| - [ ] Check that all continuous-integration tests on the `dev` branch are passing. |
Member
There was a problem hiding this comment.
Suggested change
| - [ ] Check that all continuous-integration tests on the `dev` branch are passing. | |
| - [ ] Check that all continuous-integration tests on the `dev` branch pass |
|
|
||
| - [ ] Check that the full-size tests have successfully completed within the `dev` branch. | ||
| - [ ] Review the `CHANGELOG.md` to ensure it includes everything that has been added/fixed in this release. | ||
| - We recommend you also add the GitHub handle of the main contributors of each CHANGELOG entry (author, and significant reviewers etc.). |
Member
There was a problem hiding this comment.
Suggested change
| - We recommend you also add the GitHub handle of the main contributors of each CHANGELOG entry (author, and significant reviewers etc.). | |
| - Add the GitHub handle of the main contributors of each CHANGELOG entry (author, significant reviewers, etc.). |
| - We recommend you also add the GitHub handle of the main contributors of each CHANGELOG entry (author, and significant reviewers etc.). | ||
| - This will mean each release on GitHub will display each contributors icons for extra visibility and recognition. | ||
| - [ ] (**First release**) Finalise the description of the pipeline in the GitHub repository. | ||
| - [ ] (**First release**) Ensure that you remove any "under development" labels in the description, README and so on. |
Member
There was a problem hiding this comment.
Suggested change
| - [ ] (**First release**) Ensure that you remove any "under development" labels in the description, README and so on. | |
| - [ ] (**First release**) Remove any "under development" labels in the description, README and so on. |
| nf-core pipelines bump-version <1.0.0> | ||
| ``` | ||
|
|
||
| - Please make sure to use strictly numeric release numbers that follow [Semantic Versioning](https://semver.org/) (for example, must be `1.0.0` NOT `v1.0.1rc`). |
Member
There was a problem hiding this comment.
Suggested change
| - Please make sure to use strictly numeric release numbers that follow [Semantic Versioning](https://semver.org/) (for example, must be `1.0.0` NOT `v1.0.1rc`). | |
| - Use strictly numeric release numbers that follow [Semantic Versioning](https://semver.org/) (for example, must be `1.0.0` NOT `v1.0.1rc`). |
| - This will mean each release on GitHub will display each contributors icons for extra visibility and recognition. | ||
| - [ ] (**First release**) Finalise the description of the pipeline in the GitHub repository. | ||
| - [ ] (**First release**) Ensure that you remove any "under development" labels in the description, README and so on. | ||
| - Ensure wording will fill into a ([Bluesky](https://bsky.app/profile/nf-co.re) and/or [Mastodon](https://mstdn.science/@nf_core)) post for the automated announcements. |
Member
There was a problem hiding this comment.
Suggested change
| - Ensure wording will fill into a ([Bluesky](https://bsky.app/profile/nf-co.re) and/or [Mastodon](https://mstdn.science/@nf_core)) post for the automated announcements. | |
| - Ensure wording will fit in a ([Bluesky](https://bsky.app/profile/nf-co.re) and/or [Mastodon](https://mstdn.science/@nf_core)) post for the automated announcements. |
| ## Before you release | ||
|
|
||
| :::warning | ||
| If this is your first release, make sure to follow the [first release tutorial](/docs/contributing/contribute-new-pipelines#make-the-first-release) for extra review requirements! |
Member
There was a problem hiding this comment.
Suggested change
| If this is your first release, make sure to follow the [first release tutorial](/docs/contributing/contribute-new-pipelines#make-the-first-release) for extra review requirements! | |
| If this is your first release, follow the [first release tutorial](/docs/contributing/contribute-new-pipelines#make-the-first-release) for extra review requirements. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Port over the missing release checklist page: https://nf-co.re/docs/checklists/pipeline_release
I've placed under
developers > pipelineas I think that's the most instinctive place I would look (I'm developing > a Pipeline)I've done a an overhaul at the same time as there were some difficiencies I felt when I was using it yesterrday, so while it was fresh in my mind decided to do it a once over.
I did a manual check against the style guide as far as I could (German trains made it difficult to do proper AI 'review' against the style guide).