Skip to content

Commit 83950b2

Browse files
committed
Update customize-the-agent-environment.md
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
1 parent 2bbba3c commit 83950b2

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ Instead, you can preconfigure {% data variables.product.prodname_copilot_short %
4040

4141
A `copilot-setup-steps.yml` file looks like a normal {% data variables.product.prodname_actions %} workflow file, but must contain a single `copilot-setup-steps` job. This job will be executed in {% data variables.product.prodname_actions %} before {% data variables.product.prodname_copilot_short %} starts working. For more information on {% data variables.product.prodname_actions %} workflow files, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions).
4242

43+
> [!NOTE]
44+
> You must have merged the yml file into your default branch
45+
4346
Here is a simple example of a `copilot-setup-steps.yml` file for a TypeScript project that clones the project, installs Node.js and downloads and caches the project's dependencies. You should customize this to fit your own project's language(s) and dependencies:
4447

4548
```yaml copy

0 commit comments

Comments
 (0)