Clarify 'description' key is optional for composite actions
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- github-actions
调研方向
从 docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax 的元数据语法文章开始，并查看链接的 pull request，核对提议的措辞。更新 composite-action 描述要求，以反映该描述是可选的，同时说明强烈建议提供该描述，然后验证文章是否能正确渲染。
由索引模型根据 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?
https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax
What part(s) of the article would you like to see updated?
For composite actions, the description key is not strictly required in the action.yml for the composite action to function correctly (see Additional Information for proof).
Instead of Required this should either have an addendum like in the pull request (that is, that description is not required for composite actions, or change Required to optional. In either case, it is probably worth it to state that a description key is highly recommended.
Additional information
I just ran a workflow run that calls a composite action whose action.yml file did not include a description key at the time this workflow ran. The workflow ran as expected (all the composite action does is produce an output that gets passed to the calling workflow).
See https://github.com/mcummings128/gh-actions-outputs-experiments-1/actions/runs/24743176941 for details.
This commit SHA shows the description key was removed from the composite action during the time the workflow ran.
https://github.com/mcummings128/gh-actions-outputs-experiments-1/commit/6037d82f9910c7d186845393ab2b4a53617b2bde
Lastly, please see the pull request this is linked to: https://github.com/github/docs/pull/43911
- 主要语言
- TypeScript
- 星标
- 20.9k
- 派生
- 68.8k
- 平均合并
- 15 小时 4 分钟
- 30 天内合并 PR
- 103
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/docs 的其他 Issue
-
builder persona content
难度 1/5 1 小时以内 新手友好度 90/100
-
localization
难度 2/5 1-2 天 新手友好度 72/100
-
builder persona
难度 2/5 1-3 小时 新手友好度 82/100
-
content localization
难度 2/5 1-3 小时 新手友好度 78/100
-
content localization
难度 1/5 1 小时以内 新手友好度 92/100
相似的 Issue
-
comp/desktop P3 type/bug
难度 1/5 1 小时以内 新手友好度 92/100
NousResearch/hermes-agent#118866 ·
-
Browser Waiting for: Product Owner
难度 2/5 1-3 小时 新手友好度 85/100
getsentry/sentry-javascript#24577 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
agilepathway/label-checker#640 ·
-
Plugin stuck at "loading" on DSH 0.1.6-alpha.2 — turnTail list slot registration missing options.id 未关闭
难度 2/5 1-3 小时 新手友好度 88/100
-
难度 2/5 1-3 小时 新手友好度 68/100
chrisparsons83/flexspotff#153 ·