1
0
mirror of https://github.com/go-task/task.git synced 2025-02-09 13:47:06 +02:00

docs: add an example of a default value usage in vars (#1893)

This commit is contained in:
George Green 2024-11-01 20:04:46 +01:00 committed by GitHub
parent fe09c01637
commit 47f5e6ab89
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1212,6 +1212,28 @@ tasks:
- echo "{{.GREETING}}"
```
Example of a `default` value to be overriden from CLI:
```yaml
version: '3'
greet_user:
desc: "Greet the user with a name."
vars:
USER_NAME: '{{.USER_NAME| default "DefaultUser"}}'
cmds:
- echo "Hello, {{.USER_NAME}}!"
```
```shell
$ task greet_user
task: [greet_user] echo "Hello, DefaultUser!"
Hello, DefaultUser!
$ task greet_user USER_NAME="Bob"
task: [greet_user] echo "Hello, Bob!"
Hello, Bob!
```
### Dynamic variables
The below syntax (`sh:` prop in a variable) is considered a dynamic variable.