From 8aaee8a8bf1f499ed4b014e03548ceb86569cb9f Mon Sep 17 00:00:00 2001 From: ssmurfgg04 Date: Fri, 16 Oct 2026 16:10:00 +0000 Subject: [PATCH] Document description, default and options keys for workflow_dispatch inputs The workflow-syntax reference documented only required and type for on.workflow_dispatch.inputs., 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. --- .../workflows-and-actions/workflow-syntax.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/content/actions/reference/workflows-and-actions/workflow-syntax.md b/content/actions/reference/workflows-and-actions/workflow-syntax.md index 0953709ba987..3a932069a577 100644 --- a/content/actions/reference/workflows-and-actions/workflow-syntax.md +++ b/content/actions/reference/workflows-and-actions/workflow-syntax.md @@ -329,14 +329,26 @@ A boolean specifying whether the secret must be supplied. {% data reusables.actions.workflow-dispatch-inputs-example %} +## `on.workflow_dispatch.inputs..description` + +A string description of the input parameter. + ## `on.workflow_dispatch.inputs..required` A boolean specifying whether the input must be supplied. +## `on.workflow_dispatch.inputs..default` + +The default value for this input, used when the workflow is triggered manually without a value being supplied for the input. + ## `on.workflow_dispatch.inputs..type` 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`. +## `on.workflow_dispatch.inputs..options` + +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`. + ## `permissions` {% data reusables.actions.jobs.section-assigning-permissions-to-jobs %}