Signal that the copilot-setup-steps.yml samples are illustrative - #45862
Open
brignano wants to merge 1 commit into
Open
Signal that the copilot-setup-steps.yml samples are illustrative#45862brignano wants to merge 1 commit into
copilot-setup-steps.yml samples are illustrative#45862brignano wants to merge 1 commit into
Conversation
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
Contributor
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. |
github-actions
Bot
added
the
triage
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why:
Closes: #45861
Follow-up to #42379 and #45823, per @subatoi's suggestions on that issue.
What's being changed (if available, include any code snippets, screenshots, or gifs):
#45823 generalized the copy around the
copilot-setup-steps.ymlsample so it reads as illustrative. Two things still worked against that, plus one consistency fix:1. The sample rendered a copy button —
content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.mdDropped the
copyannotation from the fence, so the sample keeps its syntax highlighting but no longer offers one-click copying of config the surrounding text advises against copying verbatim.2. The tutorial prompt generates the file from that article —
content/copilot/tutorials/cloud-agent/improve-a-project.mdThe step 2 prompt asks Copilot to author
copilot-setup-steps.ymlusing the reference article's details, so it reproduced both triggers. The prompt now ends:3. The extract below that prompt showed triggers the text doesn't mention — same file
The sentence above it calls out only the
on: workflow_dispatchtrigger and the job name, so the extract is trimmed to those. Without this it would contradict the prompt it's meant to help verify.Two files, three hunks, no changes to the sample workflow's own configuration.
Check off the following: