nf-core / nf-core/modules

Update pointers to test data to static GitHub links

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

Nobody has claimed this yet.

enhancement
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

Currently, there is potential for module tests to get silently broken where non-static GitHub links to the test data repo are used (e.g. to branches). So someone can update the test data, and then the next person to make a related PR on the modules repo gets an error unrelated to their changes.

Describe the solution you'd like

We should update all such examples to static links, probably just to the latest SHA. Probably just some bash find-and-replace.

Describe alternatives you've considered

No response

Additional context

https://nfcore.slack.com/archives/C043UU89KKQ/p1690903004273109

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 searching the module tests for non-static GitHub links to the test data repository, using the proposed bash find-and-replace approach. Update each matching link to a commit SHA and verify that no branch-based links remain, so test data changes cannot silently break later module changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, github
Domain
testing
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.