No description
Find a file
2024-04-05 06:19:10 +00:00
.github chore(deps): update codecov/codecov-action digest to 7afa10e 2024-04-05 06:19:10 +00:00
.husky chore: Initialize husky 2024-02-03 11:20:30 -06:00
.vscode chore: Remove unused parameters from debug configuration 2024-02-29 19:05:07 -06:00
docs/images art: Add nf-core logo to README 2023-08-11 12:20:28 -05:00
src feat!: Remove url resolver for NextflowRelease 2024-02-29 19:05:07 -06:00
test test: Add test for install_nextflow 2024-02-29 19:05:07 -06:00
.actrc chore: Remove GITHUB_TOKEN from actrc 2024-02-29 19:05:07 -06:00
.eslintignore build: Add eslint and prettier 2022-11-17 19:32:25 +00:00
.eslintrc.json style: Add simple-import-sort and run 2022-11-17 19:32:25 +00:00
.gitattributes refactor: Move everything into a src/ dir 2022-11-17 19:32:25 +00:00
.gitignore chore: Add ability to deal with temporary files generated by tests 2024-02-29 19:05:07 -06:00
.prettierignore build: Add eslint and prettier 2022-11-17 19:32:25 +00:00
.prettierrc.json style: Use double-quotes 2022-11-17 19:32:25 +00:00
action.yml chore!: Remove unused parameters from action.yml 2024-02-29 19:05:07 -06:00
CHANGELOG.md chore: Bump version in CHANGELOG to v2.0.0 2024-02-29 19:14:09 -06:00
LICENSE chore: Update license to MIT and nf-core 2022-11-17 19:32:25 +00:00
package-lock.json chore(deps): update typescript-eslint monorepo to v7.4.0 2024-03-26 22:39:13 -05:00
package.json chore(deps): update typescript-eslint monorepo to v7.4.0 2024-03-26 22:39:13 -05:00
README.md chore: Remove GitHub token from README 2024-02-29 19:05:07 -06:00
tsconfig.json chore: Add moduleResolution directive to tsconfig 2024-02-29 18:33:01 -06:00

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.