nf-core / nf-core/website

Pipeline pages should list version compatibility

Open
#4,398 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Is your feature request related to a problem? Please describe.
The most recent version of a pipeline aren't always with the most recent nf-core and Nextflow versions, and the resulting errors are often obtuse

Describe the solution you'd like
List the compatible version of nf-core and Nextflow on the pipeline page (e.g. https://nf-co.re/ampliseq). Version compatibility is already listed on the pipeline versions page (https://nf-co.re/pipeline_versions), so the information is already available. Ideally, the compatibility would be linked to the version of the pipeline being shown.

Describe alternatives you've considered
Testing version compatibility on run/download could also be helpful, but probably significantly more complicated.

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

Use the pipeline page at https://nf-co.re/ampliseq and the pipeline versions page at https://nf.co.re/pipeline_versions as entry points, and trace how their version information is presented. Add the compatible nf-core and Nextflow versions to each pipeline page, linked to the displayed pipeline version; done means the page matches the existing compatibility data without requiring compatibility checks during download or execution.

Written by the indexing model from the issue text.

Assessment

Domain
web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.