From 5c309e7de991f328afe909d4d3a3401e002fae78 Mon Sep 17 00:00:00 2001 From: Pete Davison Date: Tue, 9 Sep 2025 23:20:18 +0000 Subject: [PATCH 1/2] docs: add mise and github actions installation methods --- website/src/docs/getting-started.md | 10 +++--- website/src/docs/installation.md | 48 +++++++++++++++++++++++------ 2 files changed, 43 insertions(+), 15 deletions(-) diff --git a/website/src/docs/getting-started.md b/website/src/docs/getting-started.md index b19dd9d834..f61d40c2b9 100644 --- a/website/src/docs/getting-started.md +++ b/website/src/docs/getting-started.md @@ -71,9 +71,9 @@ task default Note that we don't have to specify the name of the Taskfile. Task will automatically look for a file called `Taskfile.yml` (or any of Task's -[supported file names](/docs/guide#supported-file-names)) in the current directory. -Additionally, tasks with the name `default` are special. They can also be run -without specifying the task name. +[supported file names](/docs/guide#supported-file-names)) in the current +directory. Additionally, tasks with the name `default` are special. They can +also be run without specifying the task name. If you created a Taskfile in a different directory, you can run it by passing the absolute or relative path to the directory as an argument using the `--dir` @@ -129,5 +129,5 @@ task build That's about it for the basics, but there's _so much_ more that you can do with Task. Check out the rest of the documentation to learn more about all the features Task has to offer! We recommend taking a look at the -[usage guide](/docs/guide) next. Alternatively, you can check out our reference docs -for the [Taskfile schema](reference/schema) and [CLI](reference/cli). +[usage guide](/docs/guide) next. Alternatively, you can check out our reference +docs for the [Taskfile schema](reference/schema) and [CLI](reference/cli). diff --git a/website/src/docs/installation.md b/website/src/docs/installation.md index 5caf7e0990..1a560697a1 100644 --- a/website/src/docs/installation.md +++ b/website/src/docs/installation.md @@ -10,9 +10,11 @@ Task offers many installation methods. Check out the available methods below. ## Official Package Managers -These installation methods are maintained by the Task team and are always up-to-date. +These installation methods are maintained by the Task team and are always +up-to-date. ### [dnf](https://docs.fedoraproject.org/en-US/quick-docs/dnf) ![Fedora](https://img.shields.io/badge/Fedora-51A2DA?logo=fedora&logoColor=fff) ![CentOS](https://img.shields.io/badge/CentOS-002260?logo=centos&logoColor=F0F0F0) ![Fedora](https://img.shields.io/badge/Red_Hat-EE0000?logo=redhat&logoColor=white) {#dnf} + [[package](https://cloudsmith.io/~task/repos/task/packages/?sort=-format&q=format%3Arpm)] If you Set up the repository by running : @@ -20,6 +22,7 @@ If you Set up the repository by running : ```shell curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.rpm.sh' | sudo -E bash ``` + Then you can install Task with: ```shell @@ -30,11 +33,12 @@ dnf install task [[package](https://cloudsmith.io/~task/repos/task/packages/?sort=-format&q=format%3Adeb)] -If you Set up the repository by running : +If you Set up the repository by running: ```shell curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.deb.sh' | sudo -E bash ``` + Then you can install Task with: ```shell @@ -95,7 +99,31 @@ winget install Task.Task ::: warning Community Maintained -These installation methods are maintained by the community and may not always be up-to-date with the latest Task version. The Task team does not directly control these packages. +These installation methods are maintained by the community and may not always be +up-to-date with the latest Task version. The Task team does not directly control +these packages. + +::: + +### [Mise](https://mise.jdx.dev/) ![macOS](https://img.shields.io/badge/MacOS-000000?logo=apple&logoColor=F0F0F0) ![Linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black) ![Windows](https://custom-icon-badges.demolab.com/badge/Windows-0078D6?logo=windows11&logoColor=white) {#mise} + +Mise is a cross-platform package manager that acts as a "frontend" to a variety +of other package managers "backends" such as `asdf`, `aqua` and `ubi`. + +If using Mise, we recommend using the `aqua` or `ubi` backends to install Task +as these install directly from our GitHub releases. + +::: code-group + +```shell [aqua] +mise use -g aqua:go-task/task@latest +mise install +``` + +```shell [ubi] +mise use -g ubi:go-task/task +mise install +``` ::: @@ -253,20 +281,20 @@ sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin ### GitHub Actions -If you want to install Task in GitHub Actions you can try using -[this action](https://github.com/arduino/setup-task) by the Arduino team: +We have an official GitHub Action to install Task in your workflows. For more +examples and configuration, check out the +[go-task/action repository](https://github.com/go-task/action). ```yaml - name: Install Task - uses: arduino/setup-task@v2 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} + uses: go-task/action@v1 ``` ::: warning Community Maintained -These installation methods are maintained by the community and may not always be up-to-date with the latest Task version. The Task team does not directly control these packages. +These installation methods are maintained by the community and may not always be +up-to-date with the latest Task version. The Task team does not directly control +these packages. ::: From e21e4db06ca759cb905bd94ffdab7c8e8abdeb7f Mon Sep 17 00:00:00 2001 From: Pete Davison Date: Wed, 10 Sep 2025 16:20:22 +0000 Subject: [PATCH 2/2] chore: rename go-task/action to go-task/setup-task --- website/src/docs/installation.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/website/src/docs/installation.md b/website/src/docs/installation.md index 1a560697a1..15c07f0006 100644 --- a/website/src/docs/installation.md +++ b/website/src/docs/installation.md @@ -281,13 +281,14 @@ sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin ### GitHub Actions -We have an official GitHub Action to install Task in your workflows. For more -examples and configuration, check out the -[go-task/action repository](https://github.com/go-task/action). +We have an [official GitHub Action](https://github.com/go-task/setup-task) to +install Task in your GitHub workflows. This repository is forked from the +fantastic project by the Arduino team. Check out the repository for more +examples and configuration. ```yaml - name: Install Task - uses: go-task/action@v1 + uses: go-task/setup-task@v1 ``` ::: warning Community Maintained