Module checks_api

Module checks_api 

Source

Enums§

ChecksSlashCreateError
struct for typed errors of method checks_slash_create
ChecksSlashCreateSuiteError
struct for typed errors of method checks_slash_create_suite
ChecksSlashGetError
struct for typed errors of method checks_slash_get
ChecksSlashGetSuiteError
struct for typed errors of method checks_slash_get_suite
ChecksSlashListAnnotationsError
struct for typed errors of method checks_slash_list_annotations
ChecksSlashListForRefError
struct for typed errors of method checks_slash_list_for_ref
ChecksSlashListForSuiteError
struct for typed errors of method checks_slash_list_for_suite
ChecksSlashListSuitesForRefError
struct for typed errors of method checks_slash_list_suites_for_ref
ChecksSlashRerequestRunError
struct for typed errors of method checks_slash_rerequest_run
ChecksSlashRerequestSuiteError
struct for typed errors of method checks_slash_rerequest_suite
ChecksSlashSetSuitesPreferencesError
struct for typed errors of method checks_slash_set_suites_preferences
ChecksSlashUpdateError
struct for typed errors of method checks_slash_update

Functions§

checks_slash_create
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. Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs. In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
checks_slash_create_suite
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you’ve disabled automatic creation using "Update repository preferences for check suites". 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 and a null value for head_branch. OAuth apps and personal access tokens (classic) cannot use this endpoint.
checks_slash_get
Gets a single check run using its id. 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. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
checks_slash_get_suite
Gets a single check suite using its id. 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 and a null value for head_branch. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
checks_slash_list_annotations
Lists annotations for a check run using the annotation id. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
checks_slash_list_for_ref
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. Note: The endpoints to manage checks only look 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. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
checks_slash_list_for_suite
Lists check runs for a check suite using its id. Note: The endpoints to manage checks only look 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. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
checks_slash_list_suites_for_ref
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. Note: The endpoints to manage checks only look 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 and a null value for head_branch. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
checks_slash_rerequest_run
Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared. For more information about how to re-run GitHub Actions jobs, see "Re-run a job from a workflow run". OAuth apps and personal access tokens (classic) cannot use this endpoint.
checks_slash_rerequest_suite
Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared. OAuth apps and personal access tokens (classic) cannot use this endpoint.
checks_slash_set_suites_preferences
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
checks_slash_update
Updates a check run for a specific commit in a repository. Note: The endpoints to manage checks only look 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. OAuth apps and personal access tokens (classic) cannot use this endpoint.