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
The OpenAPI schema can be found at
/components/schemas/check-run
Warning
As of Feb 2025 according to GitHub Support “The Checks API does not support Fine-Grained PATs or classic PATs, only GitHub Apps can use the Checks API”. Because of this you may see empty
.output.*attributes. See https://github.com/PyGithub/PyGithub/issues/3227A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not initialized will then trigger a request to complete all attributes.
A partially initialized CompletableGithubObject (completed=False) can be completed via
complete(). This requires the url to be given via parameterurlorattributes.With a requester where
Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameterurlorattributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameterurlorattributes.- Parameters:
requester – requester
headers – response headers
attributes – attributes to initialize
completed – do not update non-initialized attributes when True
url – url of this instance, overrides attributes[‘url’]
accept – use this accept header when completing this instance
- get_annotations() PaginatedList[CheckRunAnnotation]
- edit(name: str | _NotSetType = NotSet, head_sha: str | _NotSetType = NotSet, details_url: str | _NotSetType = NotSet, external_id: str | _NotSetType = NotSet, status: str | _NotSetType = NotSet, started_at: datetime | _NotSetType = NotSet, conclusion: str | _NotSetType = NotSet, completed_at: datetime | _NotSetType = NotSet, output: dict | _NotSetType = NotSet, actions: list[dict] | _NotSetType = NotSet) None