nf-core / nf-core/tools

Modules yaml schemes don't follow nf-core releases

Open
#3,668 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Have you checked the docs?
Description of the bug

When yaml schemes for modules meta.yml or environment.yml files change, they don't get tagged. It doesn't seem to affect linting through the nf-core CLI.

However, it does raise errors in IDEs that have the capabilities to validate yaml files based on it. On my end, it causes a lot of confusion from developers, which end up turning off validation as the best alternative.

Could you start tagging modules following nf-core/tools releases ? This way, we can target the correct yaml validation scheme in meta.yml files being developed, based on the version of nf-core/tools we run when developing ?

Command used and terminal output

No command to run. Problems arise in IDEs.

Relevant files

This meta is valid under nf-core 3.3.1, but since today's (07/07/2025) update to modules master, yaml validation gives errors.

meta.zip

System information

nextflow : 24.10.5
OS : Ubuntu 24.04
nf-core : 3.3.1

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 by reviewing the module meta.yml and environment.yml schema references and how nf-core/tools releases are exposed to the nf-core CLI. Compare the valid meta.zip example with the schema used by nf-core 3.3.1 and the current modules master. Done means module YAML schemes can be selected or identified by the corresponding nf-core/tools release so IDE validation uses the correct version.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.