Clarify limitations of `copilot-setup-steps` concerning call of reusable workflows
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR(30日)
- 105
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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