docs(#6757): document credential context separation in install pkg - #6758
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#6757): document credential context separation in install pkg#6758fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
The test suite's e2e installation token and dispatch's per-repo GITHUB_TOKEN are distinct credential contexts with independent permission propagation graphs. After pool repo recreation, the suite can confirm the repo exists (GetRepo) but cannot observe or predict when dispatch-side collaborator permissions are ready. This was empirically validated in #6701: both a human (PR #6703) and an agent (PR #6709) independently attempted suite-side GetCollaboratorPermission polling and both failed. Add a package-level doc comment (doc.go) explaining the two-token model, an inline note on awaitCreation warning against permission polling, and a cross-reference in the behaviour-testing guide. Closes #6757
Site previewPreview: https://21773da4-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 6:29 PM UTC · Completed 6:43 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.59 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Risk Assessment: moderate (2/5) DetailsSmall documentation-only PR by a bot adding package docs and guide entries with no protected paths, security concerns, or dependency changes; moderate churn history on touched files is the only uplift signal. |
|
Looks good to me Labels: PR adds documentation for e2e behaviour test credential context separation |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
fullsend-ai-review
Bot
added
ready-for-merge
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
Documents the credential context separation between the test suite's e2e installation token and dispatch's per-repo
GITHUB_TOKENin thepkg/behaviourtest/drivers/installpackage. This knowledge gap caused both a human developer (PR #6703) and an autonomous agent (PR #6709) to independently attempt the same incorrect suite-sideGetCollaboratorPermissionpolling approach for #6701.Related Issue
Closes #6757
Changes
doc.gowith package-level documentation explaining the two-token model: the suite's e2e GitHub App installation token vs dispatch's per-repoGITHUB_TOKEN, their independent permission propagation graphs, and why suite-side permission probing is unreliableawaitCreationinensure.gowarning against addingGetCollaboratorPermissionpolling, with a pointer todoc.godocs/guides/dev/behaviour-testing.mdunder the "Repo allocation" section, cross-referencing the package doc and issue behaviourtest: wait for permission propagation after pool repo recreate (dispatch sees no role, matrix empty) #6701Testing
go buildandgo vetpass on the changed packagego test ./pkg/behaviourtest/drivers/install/...passesgofmtproduces no changeslycheeandlint-docs-linkspass on the changed markdownChecklist
!for breaking changes)Closes #6757
Post-script verification
agent/6757-credential-context-docs)dc0f8e15488fc816f9464c63e644e17de549edd1..HEAD)