nf-core / nf-core/tools

Add and lint module Renovate comments

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

Nobody has claimed this yet.

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

Description

Related to https://github.com/nf-core/modules/issues/6504

We should:

  • Update the module template to include renovate comments
  • Automatically add renovate comments when the CLI searches bioconda and scaffolds environment.yml files
  • Lint for the presence and content of renovate comments
  • Automatically fix linting failures if --fix is specified

The final point would allow us to automate the work in https://github.com/nf-core/modules/issues/6504

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 locating the module template and the CLI code that searches Bioconda and scaffolds environment.yml files. Then trace the linting entry point and its --fix path; done means templates and generated files contain the expected Renovate comments, and linting detects and fixes missing or incorrect comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.