nf-core / nf-core/tools

Have module_changes.py check main.test.nf and environment.yml

Open
#2,774 0 comments 1 reaction 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

Perhaps module_changes.py (or some other part of the nf-core tool) should also check tests/main.test.nf, tests/main.test.nf.snap and environment.yml? (@mashehu knows what I'm getting at here :-) )

https://nfcore.slack.com/archives/CE5LG7WMB/p1708337362141659?thread_ts=1708337054.358939&cid=CE5LG7WMB

https://github.com/nf-core/tools/blob/b51c7d85e1eb29e49360d9712374cd5a95f9c6cc/nf_core/synced_repo.py#L317

Note that while main.nf and meta.yml should always be present in the module, tests/main.test.nf, tests/main.test.nf.snap and environment.yml may be missing.

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 in module_changes.py and inspect the linked nf_core/synced_repo.py location around line 317 to understand how main.nf and meta.yml are checked. Trace how a module is inspected when tests/main.test.nf, tests/main.test.nf.snap, or environment.yml is absent. Done means the relevant checks cover these optional files without assuming they are present.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.