Add the ability to skip version check for specified `include` elements.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
The latest template removed the libs directory, and moved any pipeline-specific functions into subworkflows/local/utils_nfcore_eager_pipeline/main (example from eager).
Now, we include these in the include block in each subworkflow:
include { addNewMetaFromAttributes } from '../../subworkflows/local/utils_nfcore_eager_pipeline/main'
When linting with nf-core lint we get the following warning:
Included component 'addNewMetaFromAttributes' versions are not added in main.nf
It would be great to include a way to ignore specific includes when checking for versions during linting.
Given that some functions are imported in every local subworkflow, we end up with this warning showing up multiple times. I’m worried important warnings will end up lost in the sea of these warnings otherwise.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the linting logic that checks versions for include blocks in main.nf and related subworkflows. Trace how the addNewMetaFromAttributes include produces warnings, then define and verify a way to skip specified includes without hiding unrelated version warnings.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100