nf-core / nf-core/tools

Pipeline template: only run linting and precommit if only markdown files changed in a PR

Open
#3,352 1 comment 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

We should only run pipeline tests/nf-test if actual 'code' files have changed.

If a PR only has markdown/docs changes, then we shouldn't waste compute time on testing the pipeline (as nothing has changed)

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 pipeline template and its linting, precommit, and nf-test jobs, then inspect how changed files are detected. Update the workflow so markdown or documentation-only changes skip pipeline tests while code changes still run them, and verify both change scenarios.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, testing
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.