nf-core / nf-core/modules

Add `deprecated` flag for deprecated modules

Open
#5,602 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Is your feature request related to a problem? Please describe

Together with the deprecation instructions for modules. We should add a deprecated flag to the meta.yml. This flag will be used to exclude these modules from website and nf-core/tools listing.
Also related to: https://github.com/nf-core/tools/issues/2905

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 module meta.yml files and the deprecation instructions linked in the issue, then read nf-core/tools issue #2905 to understand the consumer-side expectations. Done means the deprecated flag is consistently represented and deprecated modules are excluded from the website and nf-core/tools listings.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.