nf-core / nf-core/tools

Add linting rule that all processes with a `version` or `versions` named output gets added to the `ch_versions` channel

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

Nobody has claimed this yet.

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

Description

Description of feature

When we forget to mix in the version from a new process to the versions channel. It would be nice to add a linter that inspects all the called processes to find those that have a version, and check that they are mixed into to the ch_versions when present. Perhaps even warn when it isn't present. If folks are interested, I can take a shot at implementing this.

I wouldn't also be opposed to removing all the channel versions boiler, requested here.

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

The issue names no implementation files, tests, or entry points; start by locating the existing linting framework and checks for called processes and channel declarations. Define and test detection of version or versions outputs mixed into ch_versions, including the proposed behavior when that channel is absent; consider the related issue 6110 separately.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
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.