go/task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2025-08-10 22:42:19 +02:00
Code Issues Releases Activity

docs: small adjustment for #1220

Browse Source
This commit is contained in:
Andrey Nering
2023-07-24 22:06:40 -03:00
parent ca72f3c3a1
commit a16a5ea81a
2 changed files with 20 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/api_reference.md
View File

@@ -128,7 +128,7 @@ There are some special variables that is available on the templating system:
| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. | | `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. |
| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. | | `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. |
| `TASK_VERSION` | The current version of task. | | `TASK_VERSION` | The current version of task. |
| `ITEM` | The value of the current iteration when using the `for` property. | | `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. |
## ENV ## ENV

42
docs/docs/usage.md
View File

@@ -1043,7 +1043,9 @@ match that glob.
Source paths will always be returned as paths relative to the task directory. If Source paths will always be returned as paths relative to the task directory. If
you need to convert this to an absolute path, you can use the built-in you need to convert this to an absolute path, you can use the built-in
`joinPath` function: `joinPath` function.
There are some [special variables](/api/#special-variables) that you may find
useful for this.
```yaml ```yaml
version: '3' version: '3'
@@ -1058,7 +1060,7 @@ tasks:
- bar.txt - bar.txt
cmds: cmds:
- for: sources - for: sources
cmd: cat {{ joinPath .MY_DIR .ITEM }} cmd: cat {{joinPath .MY_DIR .ITEM}}
``` ```
### Looping over variables ### Looping over variables
@@ -1073,11 +1075,10 @@ version: '3'
tasks: tasks:
default: default:
vars: vars:
my_var: foo.txt bar.txt MY_VAR: foo.txt bar.txt
cmds: cmds:
- for: - for: { var: MY_VAR }
var: my_var cmd: cat {{.ITEM}}
cmd: cat {{ .ITEM }}
``` ```
If you need to split on a different character, you can do this by specifying the If you need to split on a different character, you can do this by specifying the
@@ -1089,12 +1090,10 @@ version: '3'
tasks: tasks:
default: default:
vars: vars:
my_var: foo.txt,bar.txt MY_VAR: foo.txt,bar.txt
cmds: cmds:
- for: - for: { var: MY_VAR, split: ',' }
var: my_var cmd: cat {{.ITEM}}
split: ','
cmd: cat {{ .ITEM }}
``` ```
All of this also works with dynamic variables! All of this also works with dynamic variables!
@@ -1105,12 +1104,11 @@ version: '3'
tasks: tasks:
default: default:
vars: vars:
my_var: MY_VAR:
sh: find -type f -name '*.txt' sh: find -type f -name '*.txt'
cmds: cmds:
- for: - for: { var: MY_VAR }
var: my_var cmd: cat {{.ITEM}}
cmd: cat {{ .ITEM }}
``` ```
### Renaming variables ### Renaming variables
@@ -1124,12 +1122,10 @@ version: '3'
tasks: tasks:
default: default:
vars: vars:
my_var: foo.txt bar.txt MY_VAR: foo.txt bar.txt
cmds: cmds:
- for: - for: { var: MY_VAR, as: FILE }
var: my_var cmd: cat {{.FILE}}
as: FILE
cmd: cat {{ .FILE }}
``` ```
### Looping over tasks ### Looping over tasks
@@ -1147,11 +1143,11 @@ tasks:
- for: [foo, bar] - for: [foo, bar]
task: my-task task: my-task
vars: vars:
FILE: '{{ .ITEM }}' FILE: '{{.ITEM}}'
my-task: my-task:
cmds: cmds:
- echo '{{ .FILE }}' - echo '{{.FILE}}'
``` ```
Or if you want to run different tasks depending on the value of the loop: Or if you want to run different tasks depending on the value of the loop:
@@ -1163,7 +1159,7 @@ tasks:
default: default:
cmds: cmds:
- for: [foo, bar] - for: [foo, bar]
task: task-{{ .ITEM }} task: task-{{.ITEM}}
task-foo: task-foo:
cmds: cmds: