You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
renovate[bot] 7efdd12908 chore(deps): update github actions 5 days ago
.github chore(deps): update github actions 5 days ago
.husky chore: Initialize husky 4 months ago
.vscode chore: Remove unused parameters from debug configuration 3 months ago
docs/images art: Add nf-core logo to README 10 months ago
src feat!: Remove url resolver for NextflowRelease 3 months ago
test test: Add test for install_nextflow 3 months ago
.actrc chore: Remove GITHUB_TOKEN from actrc 3 months ago
.eslintignore build: Add eslint and prettier 2 years ago
.eslintrc.json style: Add simple-import-sort and run 2 years ago
.gitattributes refactor: Move everything into a src/ dir 2 years ago
.gitignore chore: Add ability to deal with temporary files generated by tests 3 months ago
.prettierignore build: Add eslint and prettier 2 years ago
.prettierrc.json style: Use double-quotes 2 years ago
CHANGELOG.md chore: Bump version in CHANGELOG to v2.0.0 3 months ago
LICENSE chore: Update license to MIT and nf-core 2 years ago
README.md chore: Remove GitHub token from README 3 months ago
action.yml chore!: Remove unused parameters from action.yml 3 months ago
package-lock.json chore(deps): update dependency @ava/typescript to v5 2 weeks ago
package.json chore(deps): update dependency @ava/typescript to v5 2 weeks ago
tsconfig.json chore: Add moduleResolution directive to tsconfig 3 months ago

README.md

nf-core/setup-nextflow nf-core/setup-nextflow

Testing codecov MIT License GitHub tag (latest by date) Get from GitHub Actions

An action to install Nextflow into a GitHub Actions workflow and make it available for subsequent steps.

Quick start

name: Example workflow
on: push
jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: nf-core/setup-nextflow@v1
      - run: nextflow run ${GITHUB_WORKSPACE}

Inputs

All inputs are optional! 😎 By default, this action will install the latest stable release of Nextflow. You can optionally pick a different version, or choose to install all versions.

version

default: latest

A version string to specify the version of Nextflow to install. This version number will try to resolve using npm's semantic versioning, so

  • version: 21
  • version: 21.10
  • version: 21.10.6

will all download Nextflow version 21.10.6 as of 13 June 2022. Since Nextflow does not use true semantic versioning, you should always specify at least the minor version (e.g. version: 21.10).

Edge releases are resolved as pre-release, see https://github.com/npm/node-semver#prerelease-tags for more details. In short, in nearly all cases, passing an -edge release to this action will need to specify the exact edge release targeted.

There are three (technically four) aliases to assist in choosing up-to-date Nextflow versions.

  • version: latest-stable (alias version: latest)

    This will download the latest stable release of Nextflow.

  • version: latest-edge

    This will download the latest edge release of Nextflow. Note that edge releases may be older than the latest stable release. See https://github.com/nextflow-io/nextflow/issues/2467

  • version: latest-everything

    This will download the latest release of Nextflow, regardless of stable/edge status.

all

default: false

A boolean deciding whether to download the "all versions" distribution of Nextflow. May be useful for running tests against multiple versions downstream.

Outputs

There are no outputs from this action.

Why was this action made?

Slack link

You may be asking, why not just a few yaml lines?

- name: Install Nextflow
  env:
    NXF_VER: ${{ matrix.NXF_VER }}
  run: |
    wget -qO- get.nextflow.io | bash
    sudo mv nextflow /usr/local/bin/    

The versioning. From the Nextflow install script you can't get latest-edge or latest-everything for example.