Skip to content

Commit 2921450

Browse files
authored
docs: add mise and github actions installation methods (#2414)
* docs: add mise and github actions installation methods * chore: rename go-task/action to go-task/setup-task
1 parent dffa355 commit 2921450

File tree

2 files changed

+44
-15
lines changed

2 files changed

+44
-15
lines changed

website/src/docs/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ task default
7171

7272
Note that we don't have to specify the name of the Taskfile. Task will
7373
automatically look for a file called `Taskfile.yml` (or any of Task's
74-
[supported file names](/docs/guide#supported-file-names)) in the current directory.
75-
Additionally, tasks with the name `default` are special. They can also be run
76-
without specifying the task name.
74+
[supported file names](/docs/guide#supported-file-names)) in the current
75+
directory. Additionally, tasks with the name `default` are special. They can
76+
also be run without specifying the task name.
7777

7878
If you created a Taskfile in a different directory, you can run it by passing
7979
the absolute or relative path to the directory as an argument using the `--dir`
@@ -129,5 +129,5 @@ task build
129129
That's about it for the basics, but there's _so much_ more that you can do with
130130
Task. Check out the rest of the documentation to learn more about all the
131131
features Task has to offer! We recommend taking a look at the
132-
[usage guide](/docs/guide) next. Alternatively, you can check out our reference docs
133-
for the [Taskfile schema](reference/schema) and [CLI](reference/cli).
132+
[usage guide](/docs/guide) next. Alternatively, you can check out our reference
133+
docs for the [Taskfile schema](reference/schema) and [CLI](reference/cli).

website/src/docs/installation.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,19 @@ Task offers many installation methods. Check out the available methods below.
1010

1111
## Official Package Managers
1212

13-
These installation methods are maintained by the Task team and are always up-to-date.
13+
These installation methods are maintained by the Task team and are always
14+
up-to-date.
1415

1516
### [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}
17+
1618
[[package](https://cloudsmith.io/~task/repos/task/packages/?sort=-format&q=format%3Arpm)]
1719

1820
If you Set up the repository by running :
1921

2022
```shell
2123
curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.rpm.sh' | sudo -E bash
2224
```
25+
2326
Then you can install Task with:
2427

2528
```shell
@@ -30,11 +33,12 @@ dnf install task
3033

3134
[[package](https://cloudsmith.io/~task/repos/task/packages/?sort=-format&q=format%3Adeb)]
3235

33-
If you Set up the repository by running :
36+
If you Set up the repository by running:
3437

3538
```shell
3639
curl -1sLf 'https://dl.cloudsmith.io/public/task/task/setup.deb.sh' | sudo -E bash
3740
```
41+
3842
Then you can install Task with:
3943

4044
```shell
@@ -95,7 +99,31 @@ winget install Task.Task
9599

96100
::: warning Community Maintained
97101

98-
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.
102+
These installation methods are maintained by the community and may not always be
103+
up-to-date with the latest Task version. The Task team does not directly control
104+
these packages.
105+
106+
:::
107+
108+
### [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}
109+
110+
Mise is a cross-platform package manager that acts as a "frontend" to a variety
111+
of other package managers "backends" such as `asdf`, `aqua` and `ubi`.
112+
113+
If using Mise, we recommend using the `aqua` or `ubi` backends to install Task
114+
as these install directly from our GitHub releases.
115+
116+
::: code-group
117+
118+
```shell [aqua]
119+
mise use -g aqua:go-task/task@latest
120+
mise install
121+
```
122+
123+
```shell [ubi]
124+
mise use -g ubi:go-task/task
125+
mise install
126+
```
99127

100128
:::
101129

@@ -253,20 +281,21 @@ sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
253281

254282
### GitHub Actions
255283

256-
If you want to install Task in GitHub Actions you can try using
257-
[this action](https://github.com/arduino/setup-task) by the Arduino team:
284+
We have an [official GitHub Action](https://github.com/go-task/setup-task) to
285+
install Task in your GitHub workflows. This repository is forked from the
286+
fantastic project by the Arduino team. Check out the repository for more
287+
examples and configuration.
258288

259289
```yaml
260290
- name: Install Task
261-
uses: arduino/setup-task@v2
262-
with:
263-
version: 3.x
264-
repo-token: ${{ secrets.GITHUB_TOKEN }}
291+
uses: go-task/setup-task@v1
265292
```
266293
267294
::: warning Community Maintained
268295
269-
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.
296+
These installation methods are maintained by the community and may not always be
297+
up-to-date with the latest Task version. The Task team does not directly control
298+
these packages.
270299
271300
:::
272301

0 commit comments

Comments
 (0)