Module Api.CheckRunStatus

type t

CheckRun status type.

type action
type conclusion = [
  1. | `Failure of string
  2. | `Success
  3. | `Skipped of string
]

Sub-set of conclusions from GitHub. Not supported are action_required, cancelled, neutral, stale, or timed_out.

type state = [
  1. | `Queued
  2. | `InProgress
  3. | `Completed of conclusion
]
val action : label:string -> description:string -> identifier:string -> action
val v : ?text:string -> ?summary:string -> ?url:Uri.t -> ?actions:action list -> ?identifier:string -> state -> t

v ?text ?summary ?url ?actions ?identifier state creates a CheckRunStatus with ?text description, a link to the build details at ?url and an ?identifier for triggering a rebuild of a job.

Both text and summary are limited to 65535 by GitHub. This field will be truncated to this length. actions is limited to three actions by GitHub.