workflow_dispatch inputs: description, default and options are not documented
维护者通常 1 天内回复
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 80/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions
调研方向
缺口位于工作流语法文章中的 on.workflow_dispatch.inputs.<input_id> 部分，该部分只介绍了 required 和 type。请阅读 actions/languageservices 中 workflow-parser/src/workflow-v1.0.json 里的 workflow_dispatch 输入定义，确认 description、default 和 options 的含义，并查看 data/reusables/actions/workflow-dispatch-inputs-example.md 了解用法。完成标准是每个键都有各自简短的小节，并且 options 说明它仅适用于 choice 输入。
由索引模型根据 Issue 内容生成。
描述
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
The on.workflow_dispatch.inputs.<input_id> section documents only required and type. The description, default and options keys are not documented as headings, although the example on the same page uses all three (options for a choice input).
The workflow schema in actions/languageservices (workflow-parser/src/workflow-v1.0.json, at fb5c6e4) defines these keys for workflow_dispatch inputs:
description: a string description of the input parameter.default: used when an input parameter isn't specified in a workflow file.options: a sequence of strings; the options of the dropdown list, if the type ischoice.
Suggested change: add a short section for each of on.workflow_dispatch.inputs.<input_id>.description, .default and .options, with the options section stating that it applies only to choice inputs.
Additional information
The example in data/reusables/actions/workflow-dispatch-inputs-example.md already shows options with type: choice.
- 主要语言
- TypeScript
- 星标
- 21k
- 派生
- 69.1k
- 平均合并
- 10 小时 32 分钟
- 30 天内合并 PR
- 103
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/docs 的其他 Issue
-
triage
难度 2/5 1-3 小时 新手友好度 62/100
github/docs#46365 · 3 条评论 · 2 个 reaction ·
维护者通常 1 天内回复
-
triage
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
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 于 5 天前认领。 未关闭content
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
相似的 Issue
-
Unsampled pageload span is profiled when profileLifecycle is 'trace' (browser UI profiling)可能已有人在做 @Jxxunnn 今天认领。 未关闭Browser Waiting for: Product Owner
难度 2/5 1-3 小时 新手友好度 82/100
getsentry/sentry-javascript#25497 · 1 条评论 ·
维护者通常 1 天内回复
-
e2e-failure ready-to-code
难度 2/5 1-3 小时 新手友好度 77/100
redhat-developer/rhdh-plugin-export-overlays#4438 · 1 条评论 ·
维护者通常 1 天内回复
-
area: core
难度 2/5 1-3 小时 新手友好度 75/100
angular/angular#71422 · 1 条评论 ·
维护者通常 1 天内回复
-
bug status: needs triage
难度 2/5 1-3 小时 新手友好度 72/100
facebook/docusaurus#12739 · 1 条评论 ·
维护者通常 1 天内回复
-
factory-active task-identify-harness-labels-done task-identify-issue-type-done
难度 1/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复