interface CheckRun

Represents a GitHub check run with its state and metadata.

Properties

id: number

Unique identifier for the check run.

name: string

Name of the check run displayed in the UI.

headSha: string

SHA of the commit being checked.

Current status of the check run.

Final result, set only when status is 'completed'.

optional
title: string

Title displayed in the check run output.

optional
summary: string

Summary text shown in the check run output.

optional
text: string

Detailed markdown content.

optional
startedAt: Date

Timestamp when the check run started.

optional
completedAt: Date

Timestamp when the check run finished.

Usage

import { type CheckRun } from ".";