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

feat: allow providing single or multi prompts (#1866)

Browse Source 
* Add new type to handle single or multi prompts

* update docs

* apply review
This commit is contained in:
Matheus Mina
2024-10-29 10:37:03 -03:00
committed by GitHub
parent c4f708b222
commit 5581954fb1
7 changed files with 78 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/reference/schema.mdx
View File

@@ -88,7 +88,7 @@ vars:
| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. |
| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. |
| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. |
| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. |
| `prompt` | `[]string` | | One or more prompts that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. |
| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. |
| `aliases` | `[]string` | | A list of alternative names by which the task can be called. |
| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. |

18
website/docs/usage.mdx
View File

@@ -1878,6 +1878,24 @@ tasks:
task: "This is a dangerous command... Do you want to continue?" [y/N]
```
Prompts can be a single value or a list of prompts, like below:
```yaml
version: '3'
tasks:
example:
cmds:
- task: dangerous
dangerous:
prompt:
- This is a dangerous command... Do you want to continue?
- Are you sure?
cmds:
- echo 'dangerous command'
```
Warning prompts are called before executing a task. If a prompt is denied Task
will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue
as normal.