docs: add server-to-server token guide#2005
Open
patniko wants to merge 1 commit into
Open
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2a84bd21-23e5-4358-96f1-f343030bb869
Contributor
There was a problem hiding this comment.
Pull request overview
Adds guidance for GitHub App installation tokens and organization-attributed Copilot automation.
Changes:
- Documents setup, token minting, SDK configuration, rotation, billing, and troubleshooting.
- Links the guide from authentication documentation indexes.
Show a summary per file
| File | Description |
|---|---|
docs/README.md |
Adds the guide to the documentation map. |
docs/auth/README.md |
Links and contextualizes server-to-server authentication. |
docs/auth/authenticate.md |
Adds installation tokens to authentication options. |
docs/auth/server-to-server-tokens.md |
Provides the new end-to-end guide. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 3
- Review effort level: Medium
| @@ -0,0 +1,301 @@ | |||
| # Server-to-server tokens | |||
|
|
|||
| Use a GitHub App installation access token to authenticate the Copilot SDK from automation without relying on a user's personal access token. This flow is intended for agents, CI/CD jobs, and backend services that make Copilot requests on behalf of an organization. | |||
| Instead, leave the explicit GitHub token option unset and pass the installation token to the spawned Copilot CLI process with `COPILOT_GITHUB_TOKEN`. | ||
|
|
||
| <details open> | ||
| <summary><strong>Node.js / TypeScript</strong></summary> |
Comment on lines
+264
to
+265
| > [!NOTE] | ||
| > These examples configure the environment for the Copilot CLI process that the SDK spawns. If you connect to an already-running CLI server with a URI connection, set `COPILOT_GITHUB_TOKEN` in that server process instead. |
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
Testing
just validate-docs-extractjust validate-docs-check(TypeScript, Python, Go, and C# passed; Java validation is blocked becausemvnis not installed in this environment)