Repository navigation
Document description, default and options keys for workflow_dispatch inputs - #46345
ssmurfgg04-gif wants to merge 1 commit into
Conversation
…inputs The workflow-syntax reference documented only required and type for on.workflow_dispatch.inputs.<input_id>, 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.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
|
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. |
What article on docs.github.com is affected?
https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_dispatchinputs
What does this PR change?
Closes #46299. The
on.workflow_dispatch.inputs.<input_id>section only documentedrequiredandtype. This adds a section for each of the three keys the issue calls out, all of which the example on the same page already uses and the workflow schema defines:description: a string description of the input parameter.default: the value used when the workflow is triggered manually without a value being supplied.options: the dropdown options for the input, only usable withtype: choice.The wording follows the schema definitions in
actions/languageservices(workflow-parser/src/workflow-v1.0.json) and matches the style of the existingrequiredandtypeentries. No changes to examples were needed sincedata/reusables/actions/workflow-dispatch-inputs-example.mdalready shows all three keys.AI usage
Drafted with an AI agent (GLM, Z.ai), then reviewed by hand: each claim was checked against the issue, the workflow schema field names, and the existing entries in the file. Change verified to touch only the one file.