Skip to content

Commit dbab318

Browse files
committed
Generalize copilot-setup-steps sample intro instead of changing triggers
Revert the workflow trigger change and address the redundancy in the copy, per maintainer feedback on issue 42379: the sample is an illustrative snippet rather than something readers are expected to copy verbatim. Generalize the sentence introducing the sample so it covers workflow triggers alongside language and dependencies, and note that you wouldn't typically run on both `push` and `pull_request`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FuL8Cm3afpXSBiiGnUo7FA
1 parent 916810a commit dbab318

2 files changed

Lines changed: 1 addition & 7 deletions

File tree

‎content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ A `copilot-setup-steps.yml` file looks like a normal {% data variables.product.p
4949
> [!NOTE]
5050
> The `copilot-setup-steps.yml` workflow won't trigger unless it's present on your default branch.
5151
52-
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:
52+
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, including its language(s), its dependencies, and the workflow triggers you need. For example, you wouldn't typically run on both `push` and `pull_request`.
5353

5454
```yaml copy
5555
name: "Copilot Setup Steps"
@@ -58,11 +58,7 @@ name: "Copilot Setup Steps"
5858
# allow manual testing through the repository's "Actions" tab
5959
on:
6060
workflow_dispatch:
61-
# Limit `push` to your default branch. Changes on any other branch are already validated
62-
# by the `pull_request` trigger, so this avoids two runs for the same commit.
6361
push:
64-
branches:
65-
- main
6662
paths:
6763
- .github/workflows/copilot-setup-steps.yml
6864
pull_request:

‎content/copilot/tutorials/cloud-agent/improve-a-project.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,6 @@ Creating this file is optional but is a good idea if you use {% data variables.c
9898
on:
9999
workflow_dispatch:
100100
push:
101-
branches:
102-
- main
103101
paths:
104102
- .github/workflows/copilot-setup-steps.yml
105103
pull_request:

0 commit comments

Comments
 (0)