Skip to content

Commit 8aaee8a

Browse files
Document description, default and options keys for workflow_dispatch inputs
The workflow-syntax reference documented only required and type for on.workflow_dispatch.inputs.<input_id>, but the example on the same page uses description, default and options too, and the workflow schema defines all of them. Adds a section for each of the three missing keys, matching the style of the existing entries.
1 parent 9f6e816 commit 8aaee8a

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
@@ -329,14 +329,26 @@ A boolean specifying whether the secret must be supplied.
329329

330330
{% data reusables.actions.workflow-dispatch-inputs-example %}
331331

332+
## `on.workflow_dispatch.inputs.<input_id>.description`
333+
334+
A string description of the input parameter.
335+
332336
## `on.workflow_dispatch.inputs.<input_id>.required`
333337

334338
A boolean specifying whether the input must be supplied.
335339

340+
## `on.workflow_dispatch.inputs.<input_id>.default`
341+
342+
The default value for this input, used when the workflow is triggered manually without a value being supplied for the input.
343+
336344
## `on.workflow_dispatch.inputs.<input_id>.type`
337345

338346
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`.
339347

348+
## `on.workflow_dispatch.inputs.<input_id>.options`
349+
350+
A list of strings containing the options shown in the dropdown list for this input when the workflow is triggered manually. This can only be used when the input's `type` is `choice`.
351+
340352
## `permissions`
341353

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

0 commit comments

Comments
 (0)