nf-core / nf-core/tools

Lint pipelines nextflow schema against the meta schema

Open
#3,288 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

Lint pipelines parameters schema (nextflow_schema.json) against the meta schema

To lint all pipelines, we should work on these steps:

  • Manual check of the meta schema to check we're not missing anything obvious
  • Think about hosting a copy of the meta schema somewhere else (currently under the nf-schema repo)
  • Test all / most nf-core pipelines locally to check for errors
  • Write GitHub action CI for one or two pipelines
  • Add CI to the template

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 nextflow_schema.json files and the linked parameters_meta_schema.json to identify compatibility gaps. Test the schemas across nf-core pipelines locally, then investigate how GitHub Actions and the pipeline template could enforce the linting; done means the chosen pipelines and template run the check successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, json
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.