Migrate to GitHub REST API version 2026-03-10 - #3038
Open
maxffarrell wants to merge 2 commits into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates REST requests to GitHub API version 2026-03-10.
Changes:
- Centralizes the API-version header and transport.
- Applies the version to REST clients, scope discovery, and GitHub App authentication.
- Adds request-path coverage.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file| File | Description |
|---|---|
| pkg/http/headers/headers.go | Defines the API version. |
| pkg/http/transport/api_version.go | Adds the versioning transport. |
| pkg/http/transport/api_version_test.go | Tests transport behavior. |
| internal/ghmcp/server.go | Versions stdio REST clients. |
| internal/ghmcp/oauth_test.go | Tests stdio requests. |
| pkg/github/dependencies.go | Versions per-request clients. |
| pkg/github/dependencies_test.go | Tests per-request clients. |
| pkg/scopes/fetcher.go | Updates scope discovery. |
| pkg/scopes/fetcher_test.go | Tests scope headers. |
| internal/githubapp/githubapp.go | Updates token requests. |
| internal/githubapp/githubapp_test.go | Tests token-request headers. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Sorry, something went wrong.
Comment thread
internal/ghmcp/server.go
| // and shadow the dynamic one. | ||
| restUATransport := &transport.UserAgentTransport{ | ||
| Transport: http.DefaultTransport, | ||
| Transport: &transport.APIVersionTransport{Transport: http.DefaultTransport}, |
Comment thread
pkg/github/dependencies.go
| // Construct REST client | ||
| restClient, err := gogithub.NewClient( | ||
| gogithub.WithHTTPClient(&http.Client{ | ||
| Transport: &transport.APIVersionTransport{Transport: http.DefaultTransport}, |
Comment thread
pkg/scopes/fetcher.go
Outdated
| req.Header.Set(headers.AuthorizationHeader, "Bearer "+token) | ||
| req.Header.Set(headers.AcceptHeader, "application/vnd.github+json") | ||
| req.Header.Set(headers.GitHubAPIVersionHeader, "2022-11-28") | ||
| req.Header.Set(headers.GitHubAPIVersionHeader, headers.GitHubAPIVersion) |
Comment thread
internal/githubapp/githubapp.go
Outdated
| req.Header.Set("X-GitHub-Api-Version", "2022-11-28") | ||
| req.Header.Set(headers.AuthorizationHeader, "Bearer "+jwt) | ||
| req.Header.Set(headers.AcceptHeader, "application/vnd.github+json") | ||
| req.Header.Set(headers.GitHubAPIVersionHeader, headers.GitHubAPIVersion) |
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.
Suppressed comments (1)pkg/http/transport/api_version.go:11
- Non-blocking: the exported type documentation says this transport only handles cloud requests, but RoundTrip also pins GHES requests to the compatibility version. Include GHES so the documented public behavior matches the implementation.
// APIVersionTransport sets the GitHub REST API version on requests to // GitHub.com and GitHub Enterprise Cloud.
Sorry, something went wrong.
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
Why
go-github v89 supports the 2026-03-10 API contract but still defaults generated requests to 2022-11-28. The scope probe and GitHub App token exchange also hardcoded the older version, so GitHub.com and GHEC were not consistently opting into the new contract.
GHES releases support REST API versions independently. Keeping GHES on 2022-11-28 preserves compatibility with supported releases before GHES 3.21 while allowing cloud deployments to migrate.
Closes #3037.
Validation
Fixes #3037