Skip to content

Document description, default and options keys for workflow_dispatch inputs #46345

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

Closed
ssmurfgg04-gif wants to merge 1 commit into from
Closed

Document description, default and options keys for workflow_dispatch inputs #46345

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -329,14 +329,26 @@ A boolean specifying whether the secret must be supplied.

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

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

A string description of the input parameter.

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

A boolean specifying whether the input must be supplied.

## `on.workflow_dispatch.inputs.<input_id>.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.<input_id>.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.<input_id>.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 %}
Expand Down
Loading