CheckRun¶

class github.CheckRun.CheckRun¶

This class represents check runs. The reference can be found here https://docs.github.com/en/rest/reference/checks#check-runs

app¶

Type:	`github.GithubApp.GithubApp`

check_suite_id¶

Type:	integer

completed_at¶

Type:	datetime

conclusion¶

Type:	string

details_url¶

Type:	string

external_id¶

Type:	string

head_sha¶

Type:	string

html_url¶

Type:	string

id¶

Type:	integer

name¶

Type:	string

node_id¶

Type:	string

output¶

Type:	`github.CheckRunOutput.CheckRunOutput`

pull_requests¶

Type:	list of `github.PullRequest.PullRequest`

started_at¶

Type:	datetime

status¶

Type:	string

url¶

Type:	string

get_annotations()¶

Calls:	GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
Return type:	`github.PaginatedList.PaginatedList` of `github.CheckRunAnnotation.CheckRunAnnotation`

edit(name=NotSet, head_sha=NotSet, details_url=NotSet, external_id=NotSet, status=NotSet, started_at=NotSet, conclusion=NotSet, completed_at=NotSet, output=NotSet, actions=NotSet)¶

Calls:	PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}
Parameters:	name – string head_sha – string details_url – string external_id – string status – string started_at – datetime conclusion – string completed_at – datetime output – dict actions – list of dict
Return type:	None