Clarify limitations of `copilot-setup-steps` concerning call of reusable workflows
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 74/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- github-actions
调研方向
从链接的 customize-the-agent-environment 文章开始,查看其中关于 copilot-setup-steps 作业属性的文档,然后比较 reusable-workflow 和 composite-action 参考文档。记录 jobs..uses 不受支持,明确说明支持 inline steps,并包含 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?
What part(s) of the article would you like to see updated?
The documentation for copilot-setup-steps does not explicitly state that calling reusable workflows via jobs.<job-id>.uses is not supported. This causes confusion for users who try to extract shared setup logic into a reusable workflow and reference it from the copilot-setup-steps job.
Current behavior
The copilot-setup-steps.yml documentation lists the job-level properties that can be customized (steps, permissions, runs-on, services, snapshot, timeout-minutes). However, it does not explicitly call out that uses at the job level — which is how GitHub Actions reusable workflows are invoked — is not among the supported properties and will be silently ignored or will cause unexpected behavior.
A user might reasonably author:
jobs:
copilot-setup-steps:
uses: ./.github/workflows/shared-setup.yml
...expecting the reusable workflow to run as part of Copilot's environment setup, only to find it does not work as intended.
Expected behavior
The documentation should explicitly state that:
jobs.<job-id>.uses(reusable workflow calls) is not supported incopilot-setup-steps.- Only inline
stepsare supported; shared setup logic must be inlined or extracted into a composite action (usingusesinside astepsentry) rather than a reusable workflow.
Suggested workaround (to be documented)
Instead of a reusable workflow, users can extract shared setup steps into a composite action and reference it within a step:
jobs:
copilot-setup-steps:
runs-on: ubuntu-latest
steps:
- uses: ./.github/actions/shared-setup # composite action — supported
References
- 主要语言
- TypeScript
- 星标
- 20.9k
- 派生
- 68.8k
- 平均合并
- 13 小时 55 分钟
- 30 天内合并 PR
- 105
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
github/docs 的其他 Issue
-
content triage
难度 1/5 1 小时以内 新手友好度 90/100
-
localization triage
难度 2/5 1-2 天 新手友好度 72/100
-
builder persona triage
难度 2/5 1-3 小时 新手友好度 82/100
-
content localization
难度 2/5 1-3 小时 新手友好度 78/100
-
content localization
难度 1/5 1 小时以内 新手友好度 92/100
相似的 Issue
-
Type/Bug
难度 2/5 1-3 小时 新手友好度 78/100
OpenNSW/nsw-srilanka#497 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
0xMiden/bridge-portal#132 ·
-
react-doctor severity:warning tech-debt
难度 1/5 1 小时以内 新手友好度 88/100
digidem/comapeo-cloud-app#403 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 78/100