Skip to content

Document description, default and options for workflow_dispatch inputs #46300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kburym wants to merge 5 commits into
base: main
Choose a base branch
from
+12 −0
Open

Document description, default and options for workflow_dispatch inputs #46300

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a71e116
Document description, default and options for workflow_dispatch inputs
kburym Oct 13, 2026
178fae4
Merge branch 'main' into docs/workflow-dispatch-input-options
kburym Oct 14, 2026
165356b
Merge branch 'main' into docs/workflow-dispatch-input-options
kburym Oct 16, 2026
be3b5ee
Clarify workflow_dispatch input default and options
kburym Nov 4, 2026
dd0cfd2
Say options is valid only for choice inputs
kburym Nov 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/actions/reference/workflows-and-actions/workflow-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,18 @@ A boolean specifying whether the input must be supplied.

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.<input_id>.description`

A string description of the input parameter.

## `on.workflow_dispatch.inputs.<input_id>.default`

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

## `on.workflow_dispatch.inputs.<input_id>.options`

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.

## `permissions`

{% data reusables.actions.jobs.section-assigning-permissions-to-jobs %}
Expand Down
Loading