https://github.com/arduino/setup-task

GitHub Actions action to make Task available for use in your workflow
https://github.com/arduino/setup-task

github-actions taskfile

Last synced: 3 days ago
JSON representation

GitHub Actions action to make Task available for use in your workflow

• Host: GitHub
• URL: https://github.com/arduino/setup-task
• Owner: arduino
• License: gpl-3.0
• Created: 2021-05-02T07:12:17.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-02-07T11:56:38.000Z (13 days ago)
• Last Synced: 2025-02-10T09:08:34.269Z (10 days ago)
• Topics: github-actions, taskfile
• Language: TypeScript
• Homepage:
• Size: 6.38 MB
• Stars: 116
• Watchers: 7
• Forks: 16
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `arduino/setup-task`

[![Test TypeScript status](https://github.com/arduino/setup-task/actions/workflows/test-typescript-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/test-typescript-task.yml)

[![Check TypeScript status](https://github.com/arduino/setup-task/actions/workflows/check-typescript-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-typescript-task.yml)

[![Check TypeScript Configuration status](https://github.com/arduino/setup-task/actions/workflows/check-tsconfig-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-tsconfig-task.yml)

[![Check npm status](https://github.com/arduino/setup-task/actions/workflows/check-npm-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-npm-task.yml)

[![Integration Tests status](https://github.com/arduino/setup-task/actions/workflows/test-integration.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/test-integration.yml)

[![Check Action Metadata status](https://github.com/arduino/setup-task/actions/workflows/check-action-metadata-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-action-metadata-task.yml)

[![Check Prettier Formatting status](https://github.com/arduino/setup-task/actions/workflows/check-prettier-formatting-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-prettier-formatting-task.yml)

[![Check Markdown status](https://github.com/arduino/setup-task/actions/workflows/check-markdown-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-markdown-task.yml)

[![Spell Check status](https://github.com/arduino/setup-task/actions/workflows/spell-check-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/spell-check-task.yml)

[![Check License status](https://github.com/arduino/setup-task/actions/workflows/check-license.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-license.yml)

[![Check npm Dependencies status](https://github.com/arduino/setup-task/actions/workflows/check-npm-dependencies-task.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/check-npm-dependencies-task.yml)

[![Sync Labels status](https://github.com/arduino/setup-task/actions/workflows/sync-labels-npm.yml/badge.svg)](https://github.com/arduino/setup-task/actions/workflows/sync-labels-npm.yml)

A [GitHub Actions](https://docs.github.com/en/actions) action that makes the [Task](https://taskfile.dev/#/) task runner / build tool available to use in your workflow.

## Inputs

### `version`

The version of [Task](https://taskfile.dev/#/) 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 }}`](https://docs.github.com/en/actions/reference/authentication-in-a-workflow).

## Usage

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

```yaml

- name: Install Task

  uses: arduino/setup-task@v2

```

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

```yaml

- name: Install Task

  uses: arduino/setup-task@v2

  with:

    version: 2.x

```

To pin the exact version:

```yaml

- name: Install Task

  uses: arduino/setup-task@v2

  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](https://github.com/arduino/setup-task/security/policy) and report the bug to our Security Team 🛡️

Thank you!

e-mail contact: [email protected]