nf-core / nf-core/tools

Use `template.prefix` and `template.name` for `manifest.name` and `manifest.homePage`

Open
#2,797 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement linting
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

Hi

When running nf-core lint on a non nf-core pipeline I get the following linting errors:

nextflow_config: Config manifest.name did not begin with nf-core/: nf-cmgg/germline                                                                                                                                                      
nextflow_config: Config variable manifest.homePage did not begin with https://github.com/nf-core/: https://github.com/nf-cmgg/germline 

Is it possible to check for the existence of template.name and template.prefix from the .nf-core.yml file and use these instead of the hardcoded nf-core/ prefix?

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the nf-core lint entry point that reports nextflow_config errors and inspect how .nf-core.yml values are read. Run nf-core lint on a non-nf-core pipeline using template.name and template.prefix; done means manifest.name and manifest.homePage use those configured values instead of the hardcoded nf-core/ prefix.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.