Interface GitHubCommitStatus

Represents an individual commit status set by a CI/CD system or external service.

See

https://docs.github.com/en/rest/commits/statuses#list-commit-statuses-for-a-reference

interface GitHubCommitStatus {
    context: string;
    created_at: string;
    creator: GitHubUser;
    description: null | string;
    id: number;
    state: "error" | "failure" | "pending" | "success";
    target_url: null | string;
    updated_at: string;
}

Properties

context created_at creator description id state target_url updated_at

Properties

context

context: string

Context label identifying the source (e.g., 'ci/circleci')

created_at

created_at: string

ISO 8601 timestamp of creation

creator

creator: GitHubUser

User who created the status

description

description: null | string

Human-readable description

id

id: number

Unique numeric status ID

state

state: "error" | "failure" | "pending" | "success"

Status state

target_url

target_url: null | string

URL to the full details of the status

updated_at

updated_at: string

ISO 8601 timestamp of last update

Settings

Member Visibility

On This Page

Properties