Skip to content

Document description, default and options for workflow_dispatch inputs - #46300

Open
kburym wants to merge 2 commits into
github:mainfrom
kburym:docs/workflow-dispatch-input-options
Open

kburym wants to merge 2 commits into
github:mainfrom
kburym:docs/workflow-dispatch-input-options

Conversation

@kburym

@kburym kburym commented Oct 13, 2026

Copy link
Copy Markdown

Fixes #46299

The on.workflow_dispatch.inputs.<input_id> section documented only required and type. This adds sections for description, default and options, matching the workflow schema in actions/languageservices (workflow-parser/src/workflow-v1.0.json, at fb5c6e4) and the example already on the page. options is noted as applying only to choice inputs.

@github-actions

Copy link
Copy Markdown
Contributor

Please don't raise pull requests against an existing issue that another user has raised until it's been marked with a help wanted label. We need to properly assess all issues before we can accept community contributions, and determine whether it's something we need to fix internally, or how many articles are affected and what the scope of the fix will be. For now, we're going to close this pull request.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks for submitting a PR to the GitHub Docs project!

In order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, see the documentation.

@github-actions github-actions Bot closed this Oct 13, 2026
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Oct 13, 2026
@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/reference/workflows-and-actions/workflow-syntax.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@subatoi

subatoi commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Apologies as this shouldn't have been closed, since it relates to your own issue. We'll review this as a new issue/PR pairing and the appropriate team will comment as soon as possible

@subatoi subatoi reopened this Oct 14, 2026
@subatoi subatoi added content This issue or pull request belongs to the Docs Content team builder persona and removed triage Do not begin working on this issue until triaged by the team labels Oct 14, 2026
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Oct 14, 2026
@subatoi subatoi removed the triage Do not begin working on this issue until triaged by the team label Oct 14, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

builder persona content This issue or pull request belongs to the Docs Content team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

workflow_dispatch inputs: description, default and options are not documented

2 participants