1. class
  2. PCIT
  3. \
  4. GitHub
  5. \
  6. Service
  7. \
  8. Checks
  9. \
  10. Suites

Suites

class Suites

Methods

__construct(Curl $curl, string $api_url)

Suites constructor.

mixed
getSingle(string $repo_full_name, int $check_suite_id)

Get a single check suite.

mixed
listSpecificRef(string $repo_full_name, string $ref, int $app_id = null, string $check_name = null)

List check suites for a specific ref.

mixed
setPreferences(string $repo_full_name, array $auto_trigger_checks)

Set preferences for check suites on a repository.

mixed
create(string $repo_full_name, string $head_branch, string $head_sha)

By default, check suites are automatically created when you create a check run.

mixed
request(string $repo_full_name, int $check_suite_id)

Rerequest check suite.

Details

at line 27
__construct(Curl $curl, string $api_url)

Suites constructor.

Parameters

Curl $curl
string $api_url

at line 41
mixed getSingle(string $repo_full_name, int $check_suite_id)

Get a single check suite.

Parameters

string $repo_full_name
int $check_suite_id

Return Value

mixed

Exceptions

Exception

at line 59
mixed listSpecificRef(string $repo_full_name, string $ref, int $app_id = null, string $check_name = null)

List check suites for a specific ref.

Parameters

string $repo_full_name
string $ref
int $app_id
string $check_name

Return Value

mixed

Exceptions

Exception

at line 94
mixed setPreferences(string $repo_full_name, array $auto_trigger_checks)

Set preferences for check suites on a repository.

Parameters

string $repo_full_name
array $auto_trigger_checks

Return Value

mixed

Exceptions

Exception

at line 114
mixed create(string $repo_full_name, string $head_branch, string $head_sha)

By default, check suites are automatically created when you create a check run.

Parameters

string $repo_full_name
string $head_branch
string $head_sha

Return Value

mixed

Exceptions

Exception

at line 135
mixed request(string $repo_full_name, int $check_suite_id)

Rerequest check suite.

Triggers GitHub to create a new check suite, without pushing new code to a repository.

Parameters

string $repo_full_name
int $check_suite_id

Return Value

mixed

Exceptions

Exception