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
- 平均合併
- 9 小時 57 分鐘
- 30 天內合併 PR
- 109
環境準備
在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。
- 提供 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
github/docs 的其他 Issue
-
builder persona content copilot
難度 1/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
Update VS Code instructions for creating a prompt file可能已有人在做 @ashis-baral 於 3 天前認領。 未關閉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 天內回覆
-
actions builder persona
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
相似的 Issue
-
Endpoint links in the tag operations list are below the 24px target size可能已有人在做 @AdzerKI 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
ai-driven-qa bug Minor
難度 2/5 1-3 小時 新手友好度 80/100
linagora/twake-tasks#435 ·
維護者通常 1 天內回覆
-
bug domain: database priority: p1 Stellar Wave
難度 2/5 1-3 小時 新手友好度 74/100
StellarState/SS-backend#632 · 1 則留言 ·
維護者通常 1 天內回覆
-
A2A audit timestamps end in +00:00Z (invalid ISO 8601)可能已有人在做 @O1sumitkumar 今天認領。 未關閉bug good first issue help wanted python
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
`cf complete zsh >> .zshrc` fails on vanilla zsh可能重新可做 關聯的 PR 已關閉且未合併。 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
cloudflare/cf#340 ·
維護者通常 1 天內回覆