nf-core / nf-core/tools

Actions CI - use `include` for old Nextflow version

Open
#1,081 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good-first-issue linting template
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

All @nf-core pipelines must test two versions of Nextflow - the minimum required by the pipeline and the latest release.

However, it's quite common for pipelines to test multiple config profiles as well. With the normal job matrix setup this means that all test profiles are run twice, for both versions of Nextflow. This is probably overkill.

A nicer method is to use the include keyword to inject the old Nextflow version run for just the test profile as I did here: https://github.com/nf-core/diaproteomics/pull/131/files

If we like this, need to update the linting tests to allow this. Could even also update the template and make the lint tests force this style.

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 inspecting the linting tests and template involved in nf-core pipeline configuration, then compare the include-based setup in nf-core/diaproteomics PR 131. Update the checks and template if appropriate so the older Nextflow version runs only for the test profile, and verify that the linting tests accept or enforce this style.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, testing-qa, 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.