Update first release procedure #2640
Open
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-main-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Show resolved
Hide resolved
|
@nf-core-bot fix linting pretty please 🙏 |
|
So if I understand this correctly, the PR shows you the differences to the latest template release which may not be in master, making sure you're only reviewing changes between your pipeline and template instead of the changes between the old version of the template and new version of the template and pipeline changes? |
jfy133
reviewed
Jul 10, 2024
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Outdated
Show resolved
Hide resolved
…release.md Co-authored-by: James A. Fellows Yates <[email protected]>
|
Has anyone checked this process to make sure that it definitely works, with merge conflicts etc? |
mashehu
reviewed
Aug 2, 2024
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Outdated
Show resolved
Hide resolved
|
any updates here @maxulysse? |
I totally forgot about it |
|
Let me solve the merge conflicts |
✅ Deploy Preview for nf-core-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Chris Hakkaart <[email protected]>
mashehu
reviewed
Jul 29, 2025
sites/docs/src/content/docs/tutorials/adding_a_pipeline/first_release.md
Show resolved
Hide resolved
Comment on lines
+43
to
+44
| For example, if this commit message `Template update for nf-core/tools version 1.13` is the one that used for a tools sync, | ||
| the branch should be called `TEMPLATE_1.13`. |
There was a problem hiding this comment.
Suggested change
| For example, if this commit message `Template update for nf-core/tools version 1.13` is the one that used for a tools sync, | |
| the branch should be called `TEMPLATE_1.13`. | |
| For example, if the tools sync commit message was `Template update for nf-core/tools version 1.13`, call the branch `TEMPLATE_1.13`. |
| Ok - now the tough bit - does your workflow stand up to the scrutiny of the nf-core team?! | ||
| Not to worry, we're a friendly bunch. | ||
|
|
||
| To get your pipeline reviewed for its initial release, do the following: |
There was a problem hiding this comment.
Suggested change
| To get your pipeline reviewed for its initial release, do the following: | |
| To start a review for the initial release of your pipeline: |
| To get your pipeline reviewed for its initial release, do the following: | ||
|
|
||
| 1. Make a pull-request from the `dev` branch to `master` on the nf-core fork. This is a | ||
| 1. Create a new branch based on `TEMPLATE`, called `TEMPLATE_<TOOLS_VERSION>` from the version of the TEMPLATE (i.e., latest tools sync) that is in the `dev` branch you wish to merge into `master`. |
There was a problem hiding this comment.
Suggested change
| 1. Create a new branch based on `TEMPLATE`, called `TEMPLATE_<TOOLS_VERSION>` from the version of the TEMPLATE (i.e., latest tools sync) that is in the `dev` branch you wish to merge into `master`. | |
| 1. Create a new branch named `TEMPLATE_<TOOLS_VERSION>`, based on the version of `TEMPLATE` from the `dev `branch you plan to merge into `master`. |
|
|
||
| 1. Make a pull-request from the `dev` branch to `master` on the nf-core fork. This is a | ||
| 1. Create a new branch based on `TEMPLATE`, called `TEMPLATE_<TOOLS_VERSION>` from the version of the TEMPLATE (i.e., latest tools sync) that is in the `dev` branch you wish to merge into `master`. | ||
| The commit message from @nf-core-bot will help you figure what was the tools versions used. |
There was a problem hiding this comment.
Suggested change
| The commit message from @nf-core-bot will help you figure what was the tools versions used. | |
| The commit message from @nf-core-bot will help you figure out what tool versions were used. |
|
I can't remember where this got to, added some language suggestions anyway. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@netlify /docs/tutorials/adding_a_pipeline/first_release