workflow-syntax reference: `description`, `default` and `options` keys for `on.workflow_dispatch.inputs.<input_id>` are undocumented
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, yaml
调研方向
从 content/actions/reference/workflows-and-actions/workflow-syntax.md 开始，找到 on.workflow_dispatch.inputs.<input_id> 部分，特别是现有的 required 和 type 小节。为 description、default 和 options 添加相应的小节，并包含 issue 中描述的 choice 限制。当这三个键都按建议的顺序和风格记录在该处时，即为完成。
由索引模型根据 Issue 内容生成。
描述
Where the gap is
content/actions/reference/workflows-and-actions/workflow-syntax.md documents required and type for on.workflow_dispatch.inputs.<input_id>, but three sibling keys that the workflow syntax accepts are missing from the reference:
description: a string describing the input, shown in the workflow dispatch UIdefault: the value used when the workflow is triggered manually without a value suppliedoptions: the list of strings shown in the dropdown for an input whosetypeischoice
Why it matters
The workflow syntax reference is the page people land on when validating a workflow_dispatch block. The three undocumented keys behave differently from what a reader might guess (for example options is only valid for choice inputs, and default for a choice input must be one of the listed options), so having them absent from the reference leads to trial-and-error. The dedicated workflow_dispatch event page (actions/using-workflows.../events-that-trigger-workflows / workflow-dispatch event doc) does cover these keys, so the gap is specifically the syntax reference page.
Suggested fix
Add the three subsections between the existing required and type subsections, in the same style:
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 workflow is triggered manually without a value being supplied for the input.on.workflow_dispatch.inputs.<input_id>.options: a list of strings containing the options shown in the dropdown list when the workflow is triggered manually; only usable when the input'stypeischoice.
Happy to open the corresponding PR once this issue is triaged.
- 主要语言
- TypeScript
- 星标
- 21k
- 派生
- 69.1k
- 平均合并
- 10 小时 14 分钟
- 30 天内合并 PR
- 106
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/docs 的其他 Issue
-
Incorrect Auto Tier Availability Information in Copilot Documentation可能已有人在做 @ashis-baral 于 1 天前认领。 未关闭content triage
难度 1/5 1 小时以内 新手友好度 73/100
维护者通常 1 天内回复
-
builder persona content copilot
难度 1/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
Update VS Code instructions for creating a prompt file可能已有人在做 @ashis-baral 于 4 天前认领。 未关闭content
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
actions builder persona
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
actions builder persona
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
chrisparsons83/flexspotff#215 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
vitest-dev/vitest#11633 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复