Files
setup-task/README.md
per1234 0a6298e6a9 Use major version ref in example snippets
Previously, due to the lack of a release, the only option was to use the default branch name for the action ref. Using
release versions provides a more stable experience for the ordinary users of these actions and also eases ongoing
development work on the actions.

Use of the major version ref will cause the workflow to benefit from ongoing development to the action at each patch or
minor release up until such time as a new major release is made, at which time the user will be given the opportunity
to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release
before manually updating the major ref (e.g., `uses: arduino/setup-task@v2`).
2021-05-20 00:06:26 -07:00

3.4 KiB

arduino/setup-task

Test TypeScript status Check TypeScript status Check TypeScript Configuration status Check npm status Integration Tests status Check Action Metadata status Check Prettier Formatting status Check Markdown status Spell Check status Check License status

A GitHub Actions action that makes the Task task runner / build tool available to use in your workflow.

Inputs

version

The version of Task to install. Can be an exact version (e.g., 3.4.2) or a version range (e.g., 3.x).

Default: 3.x

repo-token

(Optional) GitHub access token used for GitHub API requests. Heavy usage of the action can result in workflow run failures caused by rate limiting. GitHub provides a more generous allowance for Authenticated API requests.

It will be convenient to use ${{ secrets.GITHUB_TOKEN }}.

Usage

To get the action's default version of Task just add this step:

- name: Install Task
  uses: arduino/setup-task@v1

If you want to pin a major or minor version you can use the .x wildcard:

- name: Install Task
  uses: arduino/setup-task@v1
  with:
    version: 2.x

To pin the exact version:

- name: Install Task
  uses: arduino/setup-task@v1
  with:
    version: 2.6.1

Security

If you think you found a vulnerability or other security-related bug in this project, please read our security policy and report the bug to our Security Team 🛡️ Thank you!

e-mail contact: security@arduino.cc