Skip to content

Generalize the copilot-setup-steps.yml sample introduction - #1

Closed
brignano wants to merge 66 commits into
mainfrom
claude/github-docs-42379-fix-b46de1
Closed

Generalize the copilot-setup-steps.yml sample introduction#1
brignano wants to merge 66 commits into
mainfrom
claude/github-docs-42379-fix-b46de1

Conversation

@brignano

@brignano brignano commented Sep 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Why:

Closes: github#42379

Staging PR on the fork; the upstream PR is github#45823.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Reworked per @subatoi's feedback on the issue. The earlier revision changed the sample workflow's triggers; the sample is intended as an illustrative snippet rather than something readers copy verbatim, so this addresses the redundancy in the copy instead and leaves the YAML untouched.

The sentence introducing the sample now covers workflow triggers alongside language and dependencies, and drops the trailing colon:

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.

One file changed, one line: content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

🤖 Generated with Claude Code

https://claude.ai/code/session_01FuL8Cm3afpXSBiiGnUo7FA

docs-bot and others added 17 commits September 9, 2026 07:36
@docs-bot
Merge pull request #63142 from github/repo-sync
9ef8923 
Repo sync
@sunbrye @dihydroJenoxide
Move SDK quickstart to get started (#63036)
3816ce3 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Jenni C <97056108+dihydroJenoxide@users.noreply.github.com>
Copilot-Session: a8e2667d-7f41-4341-b1ca-58c0a42d3a73
@steveward
Document the ability to delegate any PR comment to Copilot (#62901)
6851593 
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
@ashis-baral @subatoi
Update pull request commenting instructions and screenshot (github#45815
b6941f1 
)

Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
@docs-bot
Merge pull request github#45816 from github/repo-sync
59a4d1d 
Repo sync
@docs-bot
Merge pull request #63148 from github/repo-sync
da56bc6 
Repo sync
@docs-bot
Fix translated/missing assign keyword breaking repository-roles-for-a…
306e230 
…n-organization.md (ja, pt, zh, ru) (#63147)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dependabot
Bump the npm_and_yarn group across 1 directory with 4 updates (#63131)
81f2df2 
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@mchammer01
@am-stead @jf205
GitHub Code Quality: Agentic Autofix for Backlog Experiences [public …
9050d92 
…preview] (#61831)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>
Copilot-Session: cc516c8e-bdeb-4490-85c3-6ef91946419a
Copilot-Session: 2c5b1fb4-960a-4056-9b94-da74ddd243bb
Copilot-Session: e03f76ef-c46c-49a6-b767-f5b01e370f56
Copilot-Session: 7330ec01-3ba0-45a2-98bd-aa2f2c1b20f3
@SiaraMist @sunbrye
Update Copilot in Jetbrains capabilities (#63118)
4dd94cd 
Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
@docs-bot
Delete orphaned files (2026-09-07-16-29) (#63107)
441e8e7
@docs-bot
Delete orphaned features (2026-09-07-16-30) (#63108)
1c7e465
@dihydroJenoxide
FR: fixing broken links (#63150)
df9bd94 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@docs-bot
Merge pull request github#45821 from github/repo-sync
3a6ec97 
Repo sync
@docs-bot
Merge pull request #63153 from github/repo-sync
3031786 
Repo sync
@Ebonsignori
Migrate the search results page to Primer Brand (#62942)
9df6656
@Ebonsignori
Migrate the docs footer to Primer Brand MinimalFooter (Docs 2026) (#6…
a32a2ec 
…3038)
@brignano brignano changed the title Scope push to the default branch in copilot-setup-steps.yml samples Generalize the copilot-setup-steps.yml sample introduction Sep 10, 2026
ausdrew and others added 12 commits September 10, 2026 02:09
@ausdrew @vgrl
Document read-only MCP requirement for code review (#62965)
f0ca6ae 
Co-authored-by: Vanessa <vgrl@github.com>
@philip-gai
@jc-clark @mchammer01
docs: document Actions cache-mode workflow option (#62301)
be60fe4 
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Copilot-Session: f352d126-d2f4-42a0-a6e6-0e9c243c5ad0
@brignano @claude
Scope push to the default branch in copilot-setup-steps samples (gi…
1f077aa 
…thub#45823)

Co-authored-by: Claude <noreply@anthropic.com>
@pnsk @mchammer01
Change "Blocked" to "Allowed" for the default of "Suggestions matchin…
dda3921 
…g public code" (#63160)

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
@subatoi
Fix typo (#63161)
608e68c
@docs-bot @github-actions @hubwriter
Copilot CLI: Update integrations and remote control articles (#63159)
3cdc359 
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
@galaxyeden @mchammer01
Clarify CNAME record value for private GitHub Pages sites (#63163)
c76a1f5 
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
@docs-bot
Merge pull request github#45830 from github/repo-sync
dd75c5f 
Repo sync
@docs-bot
Merge pull request #63169 from github/repo-sync
9ed50c3 
Repo sync
@heiskr
Fix multi-line table cell rejoin and bare-if endif deletion (#63024)
fa961e0 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: aff2e6f9-b0df-4d2d-b8c4-b0eee8c2d7e4
@heiskr
Fix changelog agent by clearing the ai-inference model input (#63070)
ce1e164 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 45ab851f-7296-412f-b82f-319442a26698
@heiskr
Change GraphQL warning icon (#63095)
845ef69
docs-bot and others added 26 commits September 10, 2026 13:30
@docs-bot
Merge pull request github#45836 from github/repo-sync
f3619f5 
Repo sync
@docs-bot
Merge pull request #63176 from github/repo-sync
e467c2e 
Repo sync
@heiskr
Skip lockfile churn check for Dependabot (#63066)
4179b5a 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 45ab851f-7296-412f-b82f-319442a26698
@heiskr
Correct GHES deprecation issue labels, title, and dedupe (#63054)
6cfb75b 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5b62a9bc-6bf5-4396-ace7-510661e552be
@heiskr
Version links inside GraphQL schema descriptions (#63026)
3e89ef7 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: aff2e6f9-b0df-4d2d-b8c4-b0eee8c2d7e4
Copilot-Session: 276b099c-ba9c-4151-a28d-033e4c59bc0f
@docs-bot
Merge pull request github#45837 from github/repo-sync
fca2765 
Repo sync
@heiskr
Remove two dead workflows (#63122)
5012ef7 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: cf82fd62-db1e-4338-bc63-e3f6ed8c53d6
@JamieMagee @mchammer01
@github-advanced-security
automatic Dependabot access to GitHub-hosted registries docs (#63155)
a9f2a10 
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot-Session: 06f65880-f1da-4aaf-8461-7bc559490672
@mario-campos @mchammer01
Use current CodeQL frontmatter keys (#62839)
4d21b1a 
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Copilot-Session: 563b4c05-9260-4c19-8dea-c08fa303ec4c
@am-stead
[Content creation]: [Audit for Copilot IA project] Concepts: Usage an…
4a03824 
…d billing github#24161 (#63045)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@am-stead @saritai
[Content creation]: [Audit for Copilot IA project] Concepts: Models g…
91315a6 
…ithub#24290 (#63103)

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
Copilot-Session: 3924ad1b-4f15-43f9-8894-a05997f8ee7e
@ohainle @subatoi
fix: moves COPILOT_HOOKS_DENY_DEMO guard to ensure deny() in scope (g…
9e72f03 
…ithub#43103)

Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
@redsun82 @mchammer01
Docs: deprecate the all-platforms CodeQL bundle in CLI download instr…
2ae8802 
…uctions (#63083)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Copilot-Session: e6313973-c801-45fa-99c6-685dbd3eb374
@docs-bot @subatoi
Update OpenAPI Description (#63181)
f169461 
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
@sophietheking
Remove expired billing content (#63180)
19a1102
@docs-bot
Merge pull request github#45842 from github/repo-sync
1315a41 
Repo sync
@docs-bot
Merge pull request #63184 from github/repo-sync
76d4a88 
Repo sync
@docs-bot @github-actions
@hubwriter
docs: update copilot-cli content from source docs (#63016)
03c86b4 
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
@docs-bot @mchammer01
Update CodeQL CLI manual (#63141)
798b61e 
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@cheshire137 @lecoursen @isaacmbrown
Document app-delegated SSO authorization (#63073)
43490d6 
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Isaac Brown <isaacmbrown@github.com>
@docs-bot
Merge pull request github#45847 from github/repo-sync
ca58b18 
Repo sync
@docs-bot
Merge pull request #63191 from github/repo-sync
843b53b 
Repo sync
@docs-bot @dihydroJenoxide
Update audit log event data (#63185)
3ff0b32 
Co-authored-by: Jenni C <97056108+dihydroJenoxide@users.noreply.github.com>
@mario-campos
Fix unit tests in tests/convert-markdown-for-docs.ts (#63188)
c12b176 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@mario-campos
Fix link redirection for aka.ms URLs in documentation conversion (#63…
a2d810b 
…175)
@docs-bot
Merge pull request github#45848 from github/repo-sync
078b583 
Repo sync
@brignano
brignano force-pushed the claude/github-docs-42379-fix-b46de1 branch from dbab318 to 06f4ef3 Compare September 13, 2026 04:34
@claude
Signal that the copilot-setup-steps samples are illustrative
7b8ac33 
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
@brignano
brignano force-pushed the claude/github-docs-42379-fix-b46de1 branch from 06f4ef3 to 7b8ac33 Compare September 13, 2026 05:14
@brignano brignano closed this Sep 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

is it redudant to run Copilot Setup Steps on push and pull_request?