Connect GitHub
Verified against the GitHub console, November 2026
GitHub has two good lanes:
- Personal access token — fastest for many automations; saved as a Kody Key
credential with provider
github, which fills thegithubcredential@kody/githubreads. - Bring-your-own OAuth App — when you want a durable OAuth connection with your own client and rate limits.
What you get
Once connected, you can ask Kody things like:
- "List my open pull requests and summarize the review comments."
- "Create an issue in my dotfiles repo about the flaky bootstrap script."
- "What merged in acme/api this week?"
Before you start
- Personal accounts are free; no review process applies to these lanes.
- If you need repositories in an organization with OAuth App access restrictions, an org owner must approve the OAuth App before it can see org data. Fine-grained tokens have their own per-org approval flow for org-owned repositories.
- The API rate limit is 5,000 requests per hour per authenticated user.
Open the next heading when you reach that step.
search({ entity: "guide:provider_github#create-a-token" }), then
#save-the-token, then #confirm-the-call. Pull-request readiness is
#pull-request-readiness once the call succeeds.
Create a token
Open github.com/settings/personal-access-tokens/new (fine-grained). Classic tokens at github.com/settings/tokens/new also work and grant coarser access.
On that page:
- Name the token.
- Set Expiration to the date GitHub offers that matches how long you want the token. 90 days is the usual fine-grained choice. That date lives at GitHub. Kody’s Expires field is separate and comes on the next step.
- Choose Only select repositories (or all repositories).
- Pick the repository permissions this task needs. Reporting starts with Contents: Read-only and Pull requests: Read-only. A readiness check also wants Commit statuses: Read-only and Actions: Read-only. There is no Checks permission for fine-grained tokens, so they can't read individual check runs; see Pull request readiness. Add write permissions when the automation mutates.
- Generate the token and copy it once.
When the token is copied, open
search({ entity: "guide:provider_github#save-the-token" }).
Save the token
Send this page. The person pastes the token into Secret value:
https://kody.codes/connect/secret-set?name=githubAccessToken&description=GitHub%20fine-grained%20personal%20access%20token&allowedHosts=api.github.com&scope=userExpires on that page is optional. Leave it empty and Kody keeps the secret until they delete it. That cutoff is Kody’s, separate from the expiration they already set at GitHub. Fill it only when they want Kody to stop sending the token on a chosen date.
The link already lists api.github.com under Where this secret can be sent.
Saving stores the token and that host. Set the Key's provider to github on its
credential page so the smoke test and @kody/github can select it.
When they confirm the save, open
search({ entity: "guide:provider_github#confirm-the-call" }).
Confirm the call
Run this in execute:
import { credential } from 'kody:runtime'
export default async function main() {
const github = await credential('github')
const response = await github.fetch('https://api.github.com/user', {
headers: {
Accept: 'application/vnd.github+json',
'X-GitHub-Api-Version': '2022-11-28',
},
})
if (!response.ok) {
throw new Error(
`GitHub smoke test failed: ${response.status} ${await response.text()}`,
)
}
const user = (await response.json()) as { login: string }
return { login: user.login }
}A login in the result means the secret and api.github.com line up. When the
error says the host is not approved, open
/connect/secrets?name=githubAccessToken&hosts=api.github.com and run the call
again after they approve it.
Pull request readiness
Open this section when writing a readiness package, after the call above succeeds.
The pull request page shows one combined list: check runs (posted by GitHub
Actions and other apps), commit statuses, and the pull request itself.
Fine-grained tokens can't read individual check runs. They have no Checks
permission, and GET /repos/{owner}/{repo}/commits/{ref}/check-runs answers
403 Resource not accessible by personal access token. Read each signal from a
call a fine-grained token can make:
- CI verdict: GraphQL
pullRequest.commits(last: 1).nodes.commit.statusCheckRollup.state(StatusCheckRollup). It already combines every check run and commit status on the head commit:SUCCESS,PENDINGorEXPECTED,FAILUREorERROR. The reporting permissions above cover it. Ask forcontexts { totalCount }, not... on CheckRunfields: each check run node comes backnullwith aResource not accessible by personal access tokenerror. - Commit statuses:
GET /repos/{owner}/{repo}/commits/{ref}/status(combined status). Names each status in itscontextfield. Fine-grained permission: Commit statuses: Read-only. - GitHub Actions job names:
GET /repos/{owner}/{repo}/actions/runs?head_sha={sha}, thenGET /repos/{owner}/{repo}/actions/runs/{run_id}/jobsfor each run (workflow runs, workflow jobs). Fine-grained permission: Actions: Read-only. This names GitHub Actions jobs only. Checks posted by other apps (code review bots, deploy previews) count in the rollup but stay unnamed. - Reviews and the pull request
mergeablefield, from the pull request API. Fine-grained permission: Pull requests: Read-only.
The verdict query, run in execute:
import { credential } from 'kody:runtime'
export default async function main() {
const github = await credential('github')
const response = await github.fetch('https://api.github.com/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: `query ($owner: String!, $repo: String!, $number: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $number) {
commits(last: 1) {
nodes {
commit {
oid
statusCheckRollup { state contexts { totalCount } }
}
}
}
}
}
}`,
variables: { owner: 'acme', repo: 'api', number: 42 },
}),
})
type Rollup = { state: string; contexts: { totalCount: number } } | null
type Commit = { oid: string; statusCheckRollup: Rollup }
const body = (await response.json()) as {
data?: {
repository: {
pullRequest: { commits: { nodes: Array<{ commit: Commit }> } }
}
}
errors?: Array<{ message: string }>
}
if (!response.ok || body.errors?.length) {
throw new Error(
`GitHub GraphQL failed: ${response.status} ${JSON.stringify(body.errors)}`,
)
}
const commit = body.data!.repository.pullRequest.commits.nodes[0]!.commit
return {
headSha: commit.oid,
state: commit.statusCheckRollup?.state ?? 'NO_CHECKS',
totalCount: commit.statusCheckRollup?.contexts.totalCount ?? 0,
}
}To name every check run, use a credential that can read checks:
- A classic token with the
reposcope, or a GitHub OAuth App token withrepo(see Scopes).repoalso grants write access to every private repository the account can reach. - A GitHub App installation with Checks: Read-only.
Those credentials can also call check runs:
GET /repos/{owner}/{repo}/commits/{ref}/check-runs
(list check runs).
Read check runs and the combined commit status together: a green check-run list
can sit next to a failing commit status, and the reverse. The rollup state
already combines both. mergeable is its own field on the pull request.
Bring-your-own OAuth App
- Open github.com/settings/developers -> OAuth Apps -> New OAuth App.
- Fill in the application name and homepage URL, and set the Authorization
callback URL to
https://kody.codes/connect/oauth(OAuth Apps accept one callback URL; a self-hosted deployment registers its own origin plus/connect/oauth). - After creating the app, click Generate a new client secret and copy the client ID and secret.
GitHub supports S256 PKCE and recommends it. The client secret stays required at
the token endpoint, so the Kody flow is confidential. OAuth App tokens have no
scheduled expiry and there are no refresh tokens, but GitHub revokes a token
after a year without use; revoke the grant from GitHub settings to kill one
sooner. Kody sees no refresh token and no expiry at connect, records the
connection as non-expiring, and does not ask you to reconnect for a missing
refresh token. If you later turn on token expiration for the app, reconnect so
Kody picks up the refresh token.
Connect to Kody
https://kody.codes/connect/oauth?provider=github&authorizeUrl=https%3A%2F%2Fround-lake.dustinice.workers.dev%3A443%2Fhttps%2Fgithub.com%2Flogin%2Foauth%2Fauthorize&tokenUrl=https%3A%2F%2Fround-lake.dustinice.workers.dev%3A443%2Fhttps%2Fgithub.com%2Flogin%2Foauth%2Faccess_token&flow=confidential&scopes=read%3Auser%20notifications&allowedHosts=api.github.comFor a team organization, add &org=<team-slug> so the app and connection are
saved there; without it they go to the personal organization (see
guide:oauth).
Decoded: authorize URL https://github.com/login/oauth/authorize, token URL
https://github.com/login/oauth/access_token, flow=confidential, scopes
read:user notifications (space-separated; adjust per the Scopes section), and
allowedHosts=api.github.com. Add pkce=true to layer S256 PKCE on top of the
confidential exchange. Paste the client ID and secret into the setup form, then
authorize.
Verify
Saved secret: Confirm the call.
OAuth integration:
import { createAuthenticatedFetch } from 'kody:runtime'
export default async function main() {
const githubFetch = await createAuthenticatedFetch('github')
const response = await githubFetch('https://api.github.com/user', {
headers: { Accept: 'application/vnd.github+json' },
})
if (!response.ok) {
throw new Error(
`GitHub smoke test failed: ${response.status} ${await response.text()}`,
)
}
const user = (await response.json()) as { login: string }
return { login: user.login }
}Scopes
OAuth App scopes are space-delimited and coarse:
- Minimal read-mostly tier:
read:user,user:email,notifications,public_repo(public repositories only),read:org. - Fuller tier:
repogrants full read/write on private repositories — there is no read-only scope for private repos, so requesting private access means accepting write access too. Addgistfor gists.
Fine-grained tokens are the better tool when you want read-only access to private repositories: their permissions are per-repository and per-capability.
Troubleshooting
The redirect_uri MUST match the registered callback URL: the callback must be exactlyhttps://kody.codes/connect/oauth.- Organization repositories missing from results: the org restricts OAuth App access. Request approval under the org's third-party access settings, or use a fine-grained token approved for that org.
401 Bad credentialswith a saved token: the token expired or its value has a stray space. Rotate it at the token settings page and update the secret.403withX-RateLimit-Remaining: 0: the 5,000 req/hr per-user limit. Wait for the reset or batch queries with the GraphQL API.- Token exchange fails on the OAuth lane: the client secret is required even with PKCE. Regenerate the secret and reconnect.
Use the @kody/github package and verify
A saved token or integration is credentials only. Finish by forking the
@kody/github helpers so day-to-day work goes through maintained code in
your org instead of hand-rolled API calls. @kody/github is a public
community package from the @kody org.
- Search for
@kody/github. It wraps REST, GraphQL, pagination, and PR helpers. communityForkit into your org (or click Install on the listing).- Check the fork's README Prerequisites / setup. The package declares one
credential named
githubwith no kind, so the saved token (providergithub) or a GitHub OAuth connection can fill it. Helpers take no auth options: since@kody/github1.0.0, passingsecretName,integrationName, oraccountthrows. With one GitHub credential, Kody uses it. The execute credentials map is only needed when you have more than one: pass your own credential's name (the token Key you saved, or your GitHub OAuth connection) ascredentials: { github: '<credential-name>' }next tocode, or--credential github=<credential-name>with the CLI. A package that imports the fork from a job or webhook needs a default mapping for itsgithubneed on that package's Credentials tab. - Verify the fork against your credentials from
execute, adding the credentials map from step 3 if you have more than one GitHub credential:
import getViewer from 'kody:@<your-username>/github/get-viewer'
export default async function main() {
return getViewer()
}A successful response returns the GitHub login your token resolves to, and
auth names the credential it used. That proves the fork, the credential, and
api.github.com all line up.