Repository navigation
docs: drop the Contents grant for evidence reads; say not to add it - #290
Merged
Merged
Conversation
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.
Summary
The GitHub App Setup docs told operators to grant the App Contents: Read-only for the support agent's evidence reads. We are not granting it. The evidence reads only target the public CopilotKit/CopilotKit and ag-ui-protocol/ag-ui repos, which need no Contents permission. The App is installed org-wide, so Contents would expose every private repo in the org to a bot that reads untrusted issue text and posts publicly.
#289 (merged separately) narrows the evidence token to
metadata: readon the CopilotKit repo. This PR brings the docs in line:docs/deployment.md: drop the "grant Contents" pre-deploy step (and its "missing step 3" consequence), list permissions as Issues write, Discussions write, Metadata read, and replace the Contents explanation with a short "do not grant Contents" note.docs/support-agent.md: token narrowed tometadata: read; replace the "App must hold Contents" sentence with the same "do not add it" note.Docs only, no code changes.
Before / after
Before (grep for the Contents grant instruction across
docs/,README.md,apps/*/README.md):After (only the new "do not grant" sentence remains):
Live install (
app_id 4309877, copilotkit-outpost-bot), matching the documented permissions:prettier --check docs/deployment.md docs/support-agent.md: all files use Prettier code style.