Repository navigation
Conversation
|
Please don't raise pull requests against an existing issue that another user has raised until it's been marked with a |
|
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. |
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 linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
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 |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟡 Changes recommended
The documentation contains an active accuracy issue: it incorrectly says non-choice inputs may safely include options, although the parser rejects those workflows.
1 open issue
What changed in this PR
Documents the previously undocumented description, default, and options properties for workflow_dispatch inputs, aligning the reference with the workflow schema and existing examples.
Changes:
- Documents input descriptions and default values.
- Documents
optionsforchoiceinputs. - Notes that
optionsshould be described as valid only forchoiceinputs, since other input types are rejected. - Removes the unsupported requirement that a choice default must appear in
options.
| File | Summary |
|---|---|
content/​actions/​reference/​workflows-and-actions/​workflow-syntax.md |
Adds reference documentation for the three workflow_dispatch input properties and addresses the documented validation behavior for options and choice defaults. |
Review effort: Lite
|
|
||
| ## `on.workflow_dispatch.inputs.<input_id>.options` | ||
|
|
||
| A sequence of strings that sets the options of the dropdown list. A dropdown list is only shown for inputs with `type: choice`; `options` is ignored for all other input types. |
Fixes #46299
The
on.workflow_dispatch.inputs.<input_id>section documented onlyrequiredandtype. This adds sections fordescription,defaultandoptions, matching the workflow schema in actions/languageservices (workflow-parser/src/workflow-v1.0.json, at fb5c6e4) and the example already on the page.optionsis noted as applying only tochoiceinputs.