Class CommitResource

Represents a GitHub commit resource with chainable async methods.

Implements PromiseLike<GitHubCommit> so it can be awaited directly to fetch the commit info, while also exposing sub-resource methods.

Example

// Await directly to get commit info (includes stats and files)
const commit = await gh.org('github').repo('linguist').commit('abc123');

// Get CI/CD statuses for this commit
const statuses = await gh.org('github').repo('linguist').commit('abc123').statuses();

// Get the combined (aggregated) status
const combined = await gh.org('github').repo('linguist').commit('abc123').combinedStatus();

// Get GitHub Actions check runs
const checks = await gh.org('github').repo('linguist').commit('abc123').checkRuns();

Implements

PromiseLike<GitHubCommit>

Index

Methods

checkRuns combinedStatus get statuses then

Methods

checkRuns

checkRuns(
params?: CheckRunsParams,
): Promise<GitHubPagedResponse<GitHubCheckRun>>
Fetches GitHub Actions check runs for this commit.

GET /repos/{owner}/{repo}/commits/{ref}/check-runs
Parameters
- Optionalparams: CheckRunsParams
  Optional filters: check_name, status, app_id, per_page, page
Returns Promise<GitHubPagedResponse<GitHubCheckRun>>
A paged response of check runs
- Defined in src/resources/CommitResource.ts:100

combinedStatus

combinedStatus(): Promise<GitHubCombinedStatus>
Fetches the combined commit status — an aggregation of all statuses for this ref.

GET /repos/{owner}/{repo}/commits/{ref}/status

Returns Promise<GitHubCombinedStatus>
The combined status object
- Defined in src/resources/CommitResource.ts:88

get

get(): Promise<GitHubCommit>
Fetches the commit details, including stats and changed files.

GET /repos/{owner}/{repo}/commits/{ref}

Returns Promise<GitHubCommit>
The commit object with stats and files
- Defined in src/resources/CommitResource.ts:61

statuses

statuses(
params?: CommitStatusesParams,
): Promise<GitHubPagedResponse<GitHubCommitStatus>>
Fetches the individual commit statuses (from CI/CD systems via the Statuses API).

GET /repos/{owner}/{repo}/statuses/{sha}
Parameters
- Optionalparams: CommitStatusesParams
  Optional pagination: per_page, page
Returns Promise<GitHubPagedResponse<GitHubCommitStatus>>
A paged response of commit statuses
- Defined in src/resources/CommitResource.ts:73

then

then<TResult1 = GitHubCommit, TResult2 = never>(
    onfulfilled?:
        | null
        | (value: GitHubCommit) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): PromiseLike<TResult1 | TResult2>
Allows the resource to be awaited directly, resolving with the commit info. Delegates to CommitResource.get.
Type Parameters
- TResult1 = GitHubCommit
- TResult2 = never
Parameters
- Optionalonfulfilled: null | (value: GitHubCommit) => TResult1 | PromiseLike<TResult1>
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/CommitResource.ts:47

Class CommitResource

Example

Implements

Index

Methods

Methods

checkRuns

Parameters

Returns Promise<GitHubPagedResponse<GitHubCheckRun>>

combinedStatus

Returns Promise<GitHubCombinedStatus>

get

Returns Promise<GitHubCommit>

statuses

Parameters

Returns Promise<GitHubPagedResponse<GitHubCommitStatus>>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

Settings

On This Page