rayan/go-task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2026-06-30 16:14:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add CHANGELOG + improvements to #980

Browse Source 
Closes #978
This commit is contained in:
Andrey Nering
2023-01-06 21:39:57 -03:00
parent aa6c7e4b94
commit 2efb3533ec
7 changed files with 171 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/api_reference.md
View File

@@ -139,7 +139,7 @@ includes:
| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. |
| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. |
| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. |
| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. |
| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/master/src/go/build/syslist.go). Task will be skipped otherwise. |
:::info
@@ -190,7 +190,7 @@ tasks:
| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. |
| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. |
| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. |
| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. |
| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/master/src/go/build/syslist.go). Command will be skipped otherwise. |
:::info

19
docs/docs/usage.md
View File

@@ -442,8 +442,13 @@ tasks:
## Platform specific tasks and commands
If you want to restrict the running of tasks to explicit platforms, this can be achieved
using the `platforms` key. Tasks can be restricted to a specific OS, architecture or a
using the `platforms:` key. Tasks can be restricted to a specific OS, architecture or a
combination of both.
On a mismatch, the task or command will be skipped, and no error will be thrown.
The values allowed as OS or Arch are valid `GOOS` and `GOARCH` values, as
defined by the Go language
[here](https://github.com/golang/go/blob/master/src/go/build/syslist.go).
The `build-windows` task below will run only on Windows, and on any architecture:
@@ -454,7 +459,7 @@ tasks:
build-windows:
platforms: [windows]
cmds:
- echo 'Running command on windows'
- echo 'Running command on Windows'
```
This can be restricted to a specific architecture as follows:
@@ -466,7 +471,7 @@ tasks:
build-windows-amd64:
platforms: [windows/amd64]
cmds:
- echo 'Running command on windows (amd64)'
- echo 'Running command on Windows (amd64)'
```
It is also possible to restrict the task to specific architectures:
@@ -487,10 +492,10 @@ Multiple platforms can be specified as follows:
version: '3'
tasks:
build-windows:
build:
platforms: [windows/amd64, darwin]
cmds:
- echo 'Running command on windows (amd64) and darwin'
- echo 'Running command on Windows (amd64) and macOS'
```
Individual commands can also be restricted to specific platforms:
@@ -499,9 +504,9 @@ Individual commands can also be restricted to specific platforms:
version: '3'
tasks:
build-windows:
build:
cmds:
- cmd: echo 'Running command on windows (amd64) and darwin'
- cmd: echo 'Running command on Windows (amd64) and macOS'
platforms: [windows/amd64, darwin]
- cmd: echo 'Running on all platforms'
```