Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Important! Template update for nf-core/tools v3.1.0 #1747

Closed
wants to merge 2 commits into from

Conversation

nf-core-bot
Copy link
Member

Version 3.1.0 of nf-core/tools has just been released with updates to the nf-core template. This automated pull-request attempts to apply the relevant updates to this pipeline.

Please make sure to merge this pull-request as soon as possible, resolving any merge conflicts in the nf-core-template-merge-3.1.0 branch (or your own fork, if you prefer). Once complete, make a new minor release of your pipeline.

For instructions on how to merge this PR, please see https://nf-co.re/docs/contributing/sync/.

For more information about this release of nf-core/tools, please see the v3.1.0 release page.

- streetsidesoftware.code-spell-checker # Spelling checker for source code
- charliermarsh.ruff # Code linter Ruff
extensions:
#- nf-core.nf-core-extensionpack # https://github.com/nf-core/vscode-extensionpack
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A fix for this is added to the template now

Suggested change
#- nf-core.nf-core-extensionpack # https://github.com/nf-core/vscode-extensionpack
- nf-core.nf-core-extensionpack # https://github.com/nf-core/vscode-extensionpack

"git_sha": "dc94b6ee04a05ddb9f7ae050712ff30a13149164",
"installed_by": ["modules"]
},
"fgbio/callmolecularconsensusreads": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

were these modules not in modules.conig before? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, but not from the template

// TODO nf-core: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
[
name: 'Maxime Garcia',
affiliation: '',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the information for each author should be updated manually

Comment on lines +366 to 373
prov {
enabled = true
formats {
bco {
file = "${params.outdir}/pipeline_info/manifest_${trace_timestamp}.bco.json"
}
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, I think I added this by mistake when resolving merge conflicts

Suggested change
prov {
enabled = true
formats {
bco {
file = "${params.outdir}/pipeline_info/manifest_${trace_timestamp}.bco.json"
}
}
}

@@ -8,14 +8,14 @@ These are the most common things requested on pull requests (PRs).

Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.

Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/sarek/tree/master/.github/CONTRIBUTING.md)
Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/sarek/tree/main/.github/CONTRIBUTING.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if we only mention main here, we have to switch all over the place, no?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is now master because the default branch was master, once you change defaultBranch from the manifest and run nf-core pipelines sync all of these mentions will change to main.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, sorry, this was not true, the default branch is automatically detected from the git configuration :)

@@ -1,6 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/nf-core/sarek/master/assets/schema_input.json",
"$id": "https://raw.githubusercontent.com/nf-core/sarek/main/assets/schema_input.json",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if we only mention main here, we have to switch all over the place, no?

homePage = 'https://github.com/nf-core/sarek'
description = """An open-source analysis pipeline to detect germline or somatic variants from whole genome or targeted sequencing"""
mainScript = 'main.nf'
defaultBranch = 'main'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, so we really have to switch to main

@@ -421,7 +456,7 @@ validation {
https://doi.org/10.1038/s41587-020-0439-x

* Software dependencies
https://github.com/${manifest.name}/blob/master/CITATIONS.md
https://github.com/nf-core/sarek/blob/master/CITATIONS.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
https://github.com/nf-core/sarek/blob/master/CITATIONS.md
https://github.com/nf-core/sarek/blob/main/CITATIONS.md

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mirpedrol this one is still master

Comment on lines +58 to +60
- On your own fork, make a new branch `patch` based on `upstream/main` or `upstream/master`.
- Fix the bug, and bump version (X.Y.Z+1).
- A PR should be made on `master` from patch to directly this particular bug.
- Open a pull-request from `patch` to `main`/`master` with the changes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mirpedrol ok, so I don't think we need to mention master here if we move all to main in all other locations already

@mashehu
Copy link
Contributor

mashehu commented Dec 10, 2024

closing this one, so we can open a new test PR

@mashehu mashehu closed this Dec 10, 2024
@mashehu mashehu deleted the nf-core-template-merge-3.1.0 branch December 12, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants