Skip to content

Commit 8c86ec9

Browse files
kburymclaude
andauthored
Document description, default and options for workflow_dispatch inputs (#46300)
Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 6d84733 commit 8c86ec9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

‎content/actions/reference/workflows-and-actions/workflow-syntax.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,18 @@ A boolean specifying whether the input must be supplied.
337337

338338
The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `choice`, `number`, `environment` or `string`.
339339

340+
## `on.workflow_dispatch.inputs.<input_id>.description`
341+
342+
A string description of the input parameter.
343+
344+
## `on.workflow_dispatch.inputs.<input_id>.default`
345+
346+
The default value used when the input is not specified when the workflow is triggered manually. For inputs with `type: choice`, the default must be one of the values listed in `options`.
347+
348+
## `on.workflow_dispatch.inputs.<input_id>.options`
349+
350+
A sequence of strings that sets the options of the dropdown list for an input with `type: choice`. `options` is valid only for `choice` inputs: a workflow that defines `options` on an input of any other type is invalid and fails to run.
351+
340352
## `permissions`
341353

342354
{% data reusables.actions.jobs.section-assigning-permissions-to-jobs %}

0 commit comments

Comments
 (0)