GitHubCheckRunModel

pydantic model safir.github.models.GitHubCheckRunModel

A Pydantic model for the “check_run” field in a check_run webhook payload (GitHubCheckRunEventModel).

Parameters:

• id (int)

• external_id (str | None)

• head_sha (str)

• status (GitHubCheckRunStatus)

• conclusion (GitHubCheckRunConclusion | None, default: None)

• name (str)

• url (HttpUrl)

• html_url (HttpUrl)

• check_suite (GitHubCheckSuiteId)

• output (GitHubCheckRunOutput | None, default: None)

• pull_requests (list[GitHubCheckRunPrInfoModel], default: <factory>)

Fields:

• check_suite (safir.github.models.GitHubCheckSuiteId)

• conclusion (safir.github.models.GitHubCheckRunConclusion | None)

• external_id (str | None)

• head_sha (str)

• html_url (pydantic.networks.HttpUrl)

• id (int)

• name (str)

• output (safir.github.models.GitHubCheckRunOutput | None)

• pull_requests (list[safir.github.models.GitHubCheckRunPrInfoModel])

• status (safir.github.models.GitHubCheckRunStatus)

• url (pydantic.networks.HttpUrl)

field check_suite: GitHubCheckSuiteId [Required]

Brief information about the check suite.

field conclusion: GitHubCheckRunConclusion | None = None

Conclusion status, if completed.

field external_id: str | None [Required]

Identifier set by the check runner.

field head_sha: str [Required]

The SHA of the most recent commit for this check suite.

field html_url: HttpUrl [Required]

URL of the check run webpage.

field id: int [Required]

Identifier for this check run.

field name: str [Required]

Name of the check run.

field output: GitHubCheckRunOutput | None = None

Check run output, if available.

field pull_requests: list[GitHubCheckRunPrInfoModel] [Optional]

List of pull requests associated with this check run.

field status: GitHubCheckRunStatus [Required]

Status of the check run.

field url: HttpUrl [Required]

URL of the check run API resource.