CheckSuite

class github.CheckSuite.CheckSuite

This class represents check suites.

The reference can be found here https://docs.github.com/en/rest/reference/checks#check-suites

The OpenAPI schema can be found at - /components/schemas/check-run/properties/check_suite - /components/schemas/check-suite

A 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 parameter url or attributes.

With a requester where Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameter url or attributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameter url or attributes.

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

property after
Type

string

property app
Type

github.GithubApp.GithubApp

property before
Type

string

property check_runs_url
Type

string

property conclusion
Type

string

property created_at
Type

datetime.datetime

property head_branch
Type

string

property head_commit
Type

github.GitCommit.GitCommit

property head_sha
Type

string

property id
Type

int

property latest_check_runs_count
Type

int

property pull_requests
Type

list of github.PullRequest.PullRequest

property repository
Type

github.Repository.Repository

property status
Type

string

property updated_at
Type

datetime.datetime

property url
Type

string

rerequest() → bool
Calls

POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest

Return type

bool

get_check_runs(check_name: Opt[str] = NotSet, status: Opt[str] = NotSet, filter: Opt[str] = NotSet) → PaginatedList[CheckRun]
Calls

GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs