Skip to content

Commit 7b8ac33

Browse files
committed
Signal that the copilot-setup-steps samples are illustrative
Follow-up to issue 42379, per maintainer feedback. The sample workflow is meant to illustrate rather than to be copied verbatim, but two things worked against that. Drop the `copy` annotation from the sample's fence in the reference article, so it no longer renders a copy button. In the "Improve a project" tutorial, extend the prompt that asks Copilot to author the file, so the generated workflow gets a `workflow_dispatch` trigger and doesn't run on both `push` and `pull_request`. Trim the extract below it to the trigger and job name the surrounding sentence calls out, so it no longer shows triggers the text never mentions. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FuL8Cm3afpXSBiiGnUo7FA
1 parent 078b583 commit 7b8ac33

2 files changed

Lines changed: 2 additions & 8 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ A `copilot-setup-steps.yml` file looks like a normal {% data variables.product.p
5151
5252
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

54-
```yaml copy
54+
```yaml
5555
name: "Copilot Setup Steps"
5656

5757
# Automatically run the setup steps when they are changed to allow for easy validation, and

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Creating this file is optional but is a good idea if you use {% data variables.c
7979

8080
<!-- markdownlint-disable -->
8181
```text copy
82-
Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for {% data variables.copilot.copilot_cloud_agent %}, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`.
82+
Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for {% data variables.copilot.copilot_cloud_agent %}, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`, and that the workflow includes a `workflow_dispatch` trigger so that it can be run manually. Choose any other triggers to suit this repository; there's no need to run on both `push` and `pull_request`.
8383
```
8484
<!-- markdownlint-enable -->
8585

@@ -97,12 +97,6 @@ Creating this file is optional but is a good idea if you use {% data variables.c
9797
```yaml
9898
on:
9999
workflow_dispatch:
100-
push:
101-
paths:
102-
- .github/workflows/copilot-setup-steps.yml
103-
pull_request:
104-
paths:
105-
- .github/workflows/copilot-setup-steps.yml
106100

107101
jobs:
108102
copilot-setup-steps:

0 commit comments

Comments
 (0)