Get a check run

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.

Gets a single check run using its id. 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.

返回响应

🟢200Response

application/json

Body

A check performed on the code of a given code change

app

null | allOf {1}

必需

object (GitHub app)

可选

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

check_suite

object | null

必需

integer

必需

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

created_at

string <date-time>

必需

示例值:

2012-07-20T01:19:13Z

description

string | null

必需

示例值:

Deploy request from hubot

environment

string

必需

Name for the target deployment environment.

示例值:

production

integer

必需

Unique identifier of the deployment

示例值:

node_id

string

必需

示例值:

MDEwOkRlcGxveW1lbnQx

original_environment

string

可选

示例值:

staging

performed_via_github_app

null | allOf {1}

可选

production_environment

boolean

可选

Specifies if the given environment is one that end-users directly interact with. Default: false.

示例值:

true

repository_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/example

statuses_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/example/deployments/1/statuses

task

string

必需

Parameter to specify a task to execute

示例值:

deploy

transient_environment

boolean

可选

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

示例值:

true

updated_at

string <date-time>

必需

示例值:

2012-07-20T01:19:13Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/example/deployments/1

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

必需

annotations_count

integer

必需

annotations_url

string <uri>

必需

summary

string | null

必需

text

string | null

必需

title

string | null

必需

pull_requests

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

必需

#/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

请求参数

返回响应