Update Preinstalling tools or dependencies in Copilot's environment Docs#39711
Update Preinstalling tools or dependencies in Copilot's environment Docs#39711Sharra-writes merged 3 commits intogithub:mainfrom
Preinstalling tools or dependencies in Copilot's environment Docs#39711Conversation
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a critical note to the Copilot agent environment customization documentation to clarify that the copilot-setup-steps.yml file must be merged into the default branch to function properly when Copilot opens a PR.
Key Changes
- Added a note explaining the default branch requirement for the setup steps file
- Clarifies when the setup steps will be triggered in the Copilot workflow
content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md
Outdated
Show resolved
Hide resolved
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
Preinstalling tools or dependencies in Copilot's environment Docs
This comment was marked as spam.
This comment was marked as spam.
|
@stephenfinch Thanks for opening a PR! I will get this triaged for review. |
5bb2a11 to
0ce1d46
Compare
Thanks for that. Is there anything else I need to do before this can be reviewed? |
|
@stephenfinch Nope, you're good! It just takes SMEs a while to get back to me sometimes. Luckily this is a small enough change that I can probably review the writing part myself, which is the step that has been taking the longest recently, since the rest of the team is involved in a huge project. |
0024052 to
ced67b3
Compare
content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md
Outdated
Show resolved
Hide resolved
|
@stephenfinch I got the SME review and it looks good, so now I just need to make sure the phrasing matches our style guide. |
Awesome! I looked at the suggestion to the wording and it looked good to me so I committed it. |
Add note to explain how the setup-steps yml file must live on your default branch for it to be triggered when copilot opens a PR
…ize-the-agent-environment.md Co-authored-by: Sharra-writes <sharra-writes@github.com>
|
@stephenfinch Got it added to the merge queue. 🎉 We've been having some on-and-off trouble with the linter, but 🤞 it will just merge without any problems. |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Add note to explain how the setup-steps yml file must live on your default branch for it to be triggered when copilot opens a PR
Why:
The documentation does not clearly explain that the
agent-setup-steps.ymlfile must live on the default branch in order for it to run before copilot starts working on a PR.What's being changed (if available, include any code snippets, screenshots, or gifs):
Added a note to the docs page for https://docs.github.com/en/copilot/how-tos/manage-and-track-spending/monitor-premium-requests to explain that the yml file must be on the default branch.
Check off the following: