docs: fix README drift and the broken permissions in the quickstart - #79
Merged
Conversation
austenstone
force-pushed
the
austenstone-docs-accuracy
branch
from
August 20, 2026 16:07
0898e62 to
592afc7
Compare
austenstone
force-pushed
the
austenstone-workflow-hardening
branch
from
August 20, 2026 16:59
f67fea8 to
ab0a606
Compare
austenstone
force-pushed
the
austenstone-docs-accuracy
branch
2 times, most recently
from
August 20, 2026 17:20
8c39281 to
43dba88
Compare
austenstone
force-pushed
the
austenstone-workflow-hardening
branch
from
August 20, 2026 17:22
e0ad9c5 to
be60c7b
Compare
The documented quickstart declares a permissions block without contents: read, so actions/checkout runs with contents: none and fails on private repos. Same trap that silently broke copilot-labeler. Fixed, called out explicitly, and pinned by a readme-example job that runs the quickstart verbatim with scoped job permissions and fail-on-error: true. Also fixes a dead link (copilot-triage.yml has been copilot-labeler.yml), documents the undocumented actions-report workflow, corrects max-turns (the action sets no default; 5 comes from the CLI) and copilot-version (now latest), and describes copilot-config as writing settings.json. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
austenstone
force-pushed
the
austenstone-docs-accuracy
branch
from
August 20, 2026 17:24
17c0bef to
a22ffaf
Compare
austenstone
changed the base branch from
austenstone-workflow-hardening
to
main
August 20, 2026 17:24
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
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.
The quickstart in the README is broken
Declaring a
permissions:block sets every unlisted scope tonone. There is nocontents:here, soactions/checkoutruns withcontents: noneand fails on any private repo. This is the same trap that has been silently breakingcopilot-labeler.yml(see #78).Fixed: added
contents: read, bumped checkout to v7, addedtimeout-minutes, and called the trap out directly under Installation:To stop it regressing, a new
readme-examplejob runs the quickstart verbatim with those exact job-scoped permissions andfail-on-error: true. If the documented path breaks, CI goes red.Troubleshooting
Reworked entry 1 and added a new entry 2, because "green job, nothing happened" is the actual observed symptom and nothing in the docs explained it:
Drift
copilot-triage.yml(does not exist)copilot-labeler.ymlmax-turnsdefault5CLI default (5)— the action sets nonecopilot-versiondefaultprereleaselatest(per #77)copilot-config~/.copilot/settings.json" (per #77)Every relative link in the README now resolves; verified programmatically.