Clarify README

This commit is contained in:
Thomas A. Christensen II 2022-06-14 11:20:05 -05:00
parent 6ff7aa9784
commit 130ca2f785
Signed by: millironx
GPG key ID: 139C07724802BC5D

View file

@ -17,20 +17,14 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: "temurin"
java-version: "11"
- uses: MillironX/setup-nextflow@v1 - uses: MillironX/setup-nextflow@v1
with: - run: nextflow run ${GITHUB_WORKSPACE}
version: "21.10"
all: false
token: ${{ secrets.GITHUB_TOKEN }}
- run: nextflow help
``` ```
## Inputs ## Inputs
All inputs are optional! :sunglasses: By default, this action will install the [latest stable release](https://nextflow.io/docs/latest/getstarted.html#stable-edge-releases) of Nextflow. You can optionally pick a different version, or choose to install all versions.
### `version` ### `version`
> **default: `latest`** > **default: `latest`**
@ -69,7 +63,12 @@ A boolean deciding whether to download the "all versions" distribution of Nextfl
> **default: `${{ secrets.GITHUB_TOKEN }}`** > **default: `${{ secrets.GITHUB_TOKEN }}`**
This action locates the releases based upon the GitHub API, and requires an access token. The default token provided with all GitHub actions should be sufficient for all use cases. > **:warning: This really shouldn't be changed. If you think this will fix a workflow problem, triple-check everything else first. :warning:**
This action locates the releases based upon the GitHub API, and requires an access token. The default token provided with all GitHub actions should be sufficient for all use cases on GitHub. Valid reasons to change this:
- GitHub Enterprise server (and only under some configurations)
- Testing workflows locally with https://github.com/nektos/act
## Outputs ## Outputs