Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Github.CheckThe Check module exposes Github's checks API.
val create_check_run :
?token:Token.t ->
owner:string ->
repo:string ->
body:string ->
unit ->
Github_t.check_run Response.t Monad.tcreate_check_run ~owner ~repo ~body creates a new check run for a specified commit in a repository.
See create-a-check-run.
val update_check_run :
?token:Token.t ->
owner:string ->
repo:string ->
check_run_id:string ->
body:string ->
unit ->
Github_t.check_run Response.t Monad.tupdate_check_run ~owner ~repo ~check_run_id ~body for a specified check_run_id in a repository.
See update-a-check-run.
val get_check_run :
?token:Token.t ->
owner:string ->
repo:string ->
check_run_id:string ->
unit ->
Github_t.check_run Response.t Monad.tget_check_run ~owner ~repo ~check_run_id using its check_run_id in a repository.
See get-a-check-run.
val list_annotations :
?token:Token.t ->
owner:string ->
repo:string ->
check_run_id:string ->
unit ->
Github_t.check_run_annotations Response.t Monad.tlist_annotations ~owner ~repo ~check_run_id for a check run using the annotation check_run_id.
val list_check_runs :
?token:Token.t ->
owner:string ->
repo:string ->
check_suite_id:string ->
unit ->
Github_t.check_runs_list Response.t Monad.tlist_check_runs ~owner ~repo ~check_suite_id in a check suite using its check_suite_id.
val list_check_runs_for_ref :
?token:Token.t ->
owner:string ->
repo:string ->
sha:string ->
?check_name:string ->
?app_id:string ->
?status:string ->
unit ->
Github_t.check_runs_list Response.t Monad.tlist_check_runs_for_ref ~owner ~repo ~sha, the sha can be a SHA, branch name, or a tag name.
val create_check_suite :
?token:Token.t ->
owner:string ->
repo:string ->
body:string ->
unit ->
Github_t.check_suite Response.t Monad.tcreate_check_suite ~owner ~repo ~body where body is the sha of the head commit.
See create-a-check-suite.
val update_preferences_for_check_suites :
?token:Token.t ->
owner:string ->
repo:string ->
body:string ->
unit ->
Github_t.check_suite_preferences Response.t Monad.tupdate_preferences_for_check_suites ~owner ~repo ~body changes the default automatic flow when creating check suites. Where body contains an array of auto_trigger_checks
val get_check_suite :
?token:Token.t ->
owner:string ->
repo:string ->
check_suite_id:int ->
unit ->
Github_t.check_suite Response.t Monad.tget_check_suite ~owner ~repo ~check_suite_id retrieves a single check_suite using its check_suite_id
See get-a-check-suite.
val rerequest_check_suite :
?token:Token.t ->
owner:string ->
repo:string ->
check_suite_id:int ->
unit ->
unit Response.t Monad.trerequest_check_suite ~owner ~repo ~check_suite_id triggers GitHub to rerequest an existing check suite, without pushing new code to a repository.
val list_check_suites_for_ref :
?token:Token.t ->
owner:string ->
repo:string ->
sha:string ->
unit ->
Github_t.check_suite_list Response.t Monad.tlist_check_suites_for_ref ~owner ~repo ~sha lists check suites for a commit sha.