Skip to content

Commit

Permalink
Document the output of a task that defines an non-awaited process
Browse files Browse the repository at this point in the history
Closes #1004

Signed-off-by: Charles d'Avernas <[email protected]>
  • Loading branch information
cdavernas committed Jan 8, 2025
1 parent df6686a commit 9b7bf32
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions dsl-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -716,13 +716,13 @@ Provides the capability to execute external [containers](#container-process), [s

##### Properties

| Name | Type | Required | Description|
| Name | Type | Required | Description |
|:--|:---:|:---:|:---|
| run.container | [`container`](#container-process) | `no` | The definition of the container to run.<br>*Required if `script`, `shell` and `workflow` have not been set.* |
| run.script | [`script`](#script-process) | `no` | The definition of the script to run.<br>*Required if `container`, `shell` and `workflow` have not been set.* |
| run.shell | [`shell`](#shell-process) | `no` | The definition of the shell command to run.<br>*Required if `container`, `script` and `workflow` have not been set.* |
| run.workflow | [`workflow`](#workflow-process) | `no` | The definition of the workflow to run.<br>*Required if `container`, `script` and `shell` have not been set.* |
| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.<br>*Defaults to `true`.* |
| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.<br>*When set to `false`, the task cannot wait for the process to complete and thus cannot output the process’s result. In this case, it should simply output its transformed input.*<br>*Defaults to `true`.* |

##### Examples

Expand Down

0 comments on commit 9b7bf32

Please sign in to comment.