List check runs for a Git reference

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

ref

string

必需

ref parameter

Query 参数

check_name

string

可选

Returns check runs with the specified name.

status

string

可选

Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

filter

string

可选

Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

per_page

integer

可选

Results per page (max 100).

page

integer

可选

Page number of the results to fetch.

app_id

integer

可选

返回响应

🟢200Response

application/json

Body

check_runs

array[object (CheckRun) {17}]

必需

app

null | allOf {1}

必需

check_suite

object | null

必需

completed_at

string <date-time> | null

必需

示例值:

2018-05-04T01:14:52Z

conclusion

enum<string> | enum<null>

必需

枚举值:

successfailureneutralcancelledskippedtimed_outaction_required

示例值:

neutral

deployment

object (Deployment)

可选

A deployment created as the result of an Actions check run from a workflow that references an environment

details_url

string | null

必需

示例值:

https://example.com

external_id

string | null

必需

示例值:

head_sha

string

必需

The SHA of the commit that is being checked.

示例值:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url

string | null

必需

示例值:

https://github.com/github/hello-world/runs/4

integer

必需

The id of the check.

示例值:

name

string

必需

The name of the check.

示例值:

test-coverage

node_id

string

必需

示例值:

MDg6Q2hlY2tSdW40

output

object

必需

pull_requests

$ref(#/components/schemas/pull-request-minimal)[]

必需

started_at

string <date-time> | null

必需

示例值:

2018-05-04T01:14:52Z

status

enum<string>

必需

The phase of the lifecycle that the check is currently in.

枚举值:

queuedin_progresscompleted

示例值:

queued

url

string

必需

示例值:

https://api.github.com/repos/github/hello-world/check-runs/4

total_count

integer

必需