Interface GitHubCheckRun

Represents a GitHub Actions check run.

See

https://docs.github.com/en/rest/checks/runs#get-a-check-run

interface GitHubCheckRun {
    app: { id: number; name: string; slug: string };
    completed_at: null | string;
    conclusion:
        | null
        | "failure"
        | "success"
        | "action_required"
        | "cancelled"
        | "neutral"
        | "skipped"
        | "stale"
        | "timed_out";
    head_sha: string;
    html_url: string;
    id: number;
    name: string;
    started_at: null
    | string;
    status: "queued" | "in_progress" | "completed";
}

Properties

app completed_at conclusion head_sha html_url id name started_at status

Properties

app

app: { id: number; name: string; slug: string }

GitHub App that created the check run

completed_at

completed_at: null | string

ISO 8601 timestamp of when the check completed

conclusion

conclusion:
    | null
    | "failure"
    | "success"
    | "action_required"
    | "cancelled"
    | "neutral"
    | "skipped"
    | "stale"
    | "timed_out"

Conclusion (only set when status is 'completed')

head_sha

head_sha: string

The commit SHA this check run is for

html_url

html_url: string

URL to the check run details on GitHub

id

id: number

Unique numeric check run ID

name

name: string

Check run name

started_at

started_at: null | string

ISO 8601 timestamp of when the check started

status

status: "queued" | "in_progress" | "completed"

Current status

Settings

Member Visibility

On This Page

Properties