Skip to content

docs: tighten server-to-server auth guidance - #2125

Merged
SteveSandersonMS merged 4 commits into
docs/s2s-token-guidefrom
copilot/fix-s2s-token-guide
Jul 29, 2026
Merged

docs: tighten server-to-server auth guidance#2125
SteveSandersonMS merged 4 commits into
docs/s2s-token-guidefrom
copilot/fix-s2s-token-guide

Conversation

@SteveSandersonMS

Copy link
Copy Markdown
Contributor

Summary

  • recommend the built-in GITHUB_TOKEN for GitHub Actions
  • shorten the server-to-server guide and focus it on SDK-specific requirements
  • cover all six SDKs and child-process, in-process, and existing-runtime connections
  • clarify organization billing, token routing, and refresh behavior

Validation

  • parsed the Markdown, YAML workflow, and JSON token request examples
  • checked all external links
  • ran docs extraction and validated all 177 TypeScript documentation examples
  • ran 134 Node.js client transport tests

SteveSandersonMS and others added 4 commits July 29, 2026 14:10
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@SteveSandersonMS
SteveSandersonMS marked this pull request as ready for review July 29, 2026 14:35
@SteveSandersonMS
SteveSandersonMS requested a review from a team as a code owner July 29, 2026 14:35
Copilot AI review requested due to automatic review settings July 29, 2026 14:35
@SteveSandersonMS
SteveSandersonMS merged commit 8cfe556 into docs/s2s-token-guide Jul 29, 2026
14 checks passed
@SteveSandersonMS
SteveSandersonMS deleted the copilot/fix-s2s-token-guide branch July 29, 2026 14:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Tightens server-to-server authentication guidance across all SDKs and runtime modes.

Changes:

  • Recommends built-in GITHUB_TOKEN for GitHub Actions.
  • Adds concise setup examples for all six SDKs.
  • Clarifies token routing, refresh, and billing behavior.
Show a summary per file
File Description
docs/README.md Updates authentication navigation.
docs/auth/README.md Renames and expands the guide entry.
docs/auth/authenticate.md Clarifies server authentication requirements.
docs/auth/server-to-server-tokens.md Reworks the full server authentication guide.

Review details

  • Files reviewed: 4/4 changed files
  • Comments generated: 1
  • Review effort level: Medium

When you refresh the token, start a new Copilot SDK client with an updated `COPILOT_GITHUB_TOKEN` value. The Copilot CLI subprocess reads its environment when it starts and does not re-read the token during an existing session.

Rotate the GitHub App private key according to your organization's security policy. If a token is exposed, revoke the installation token and rotate the app private key.
For in-process FFI, set `COPILOT_GITHUB_TOKEN` in the host environment before loading the runtime; per-client environment options are not supported. For an existing runtime URI, set it on that runtime process.
pull Bot pushed a commit to eoinmcgee1993/copilot-sdk that referenced this pull request Jul 29, 2026
* docs: add server-to-server token guide

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 2a84bd21-23e5-4358-96f1-f343030bb869

* docs: tighten server-to-server auth guidance (github#2125)

* docs: tighten server-to-server auth guidance

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: add per-language server auth examples

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: clarify installation billing attribution

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: restore server auth troubleshooting cases

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Steve Sanderson <SteveSandersonMS@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 2a84bd21-23e5-4358-96f1-f343030bb869
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants