CheckRun

A check performed on the code of a given code change

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
id	integer	The id of the check.
head_sha	string	The SHA of the commit that is being checked.
node_id	string
external_id	string
url	string
html_url	string
details_url	string
status	string	The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
conclusion	string
started_at	string
completed_at	string
output	object
name	string	The name of the check.
check_suite	object
app	object
pull_requests	array	Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
deployment	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/check-run",
  "title": "CheckRun",
  "description": "A check performed on the code of a given code change",
  "type": "object",
  "properties": {
    "id": {
      "description": "The id of the check.",
      "example": 21,
      "type": "integer"
    },
    "head_sha": {
      "description": "The SHA of the commit that is being checked.",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "type": "string"
    },
    "node_id": {
      "type": "string",
      "example": "MDg6Q2hlY2tSdW40"
    },
    "external_id": {
      "type": "string",
      "example": "42",
      "nullable": true
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
    },
    "html_url": {
      "type": "string",
      "example": "https://github.com/github/hello-world/runs/4",
      "nullable": true
    },
    "details_url": {
      "type": "string",
      "example": "https://example.com",
      "nullable": true
    },
    "status": {
      "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
      "example": "queued",
      "type": "string",
      "enum": [
        "queued",
        "in_progress",
        "completed",
        "waiting",
        "requested",
        "pending"
      ]
    },
    "conclusion": {
      "type": "string",
      "example": "neutral",
      "enum": [
        "success",
        "failure",
        "neutral",
        "cancelled",
        "skipped",
        "timed_out",
        "action_required"
      ],
      "nullable": true
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-05-04T01:14:52Z",
      "nullable": true
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-05-04T01:14:52Z",
      "nullable": true
    },
    "output": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "nullable": true
        },
        "summary": {
          "type": "string",
          "nullable": true
        },
        "text": {
          "type": "string",
          "nullable": true
        },
        "annotations_count": {
          "type": "integer"
        },
        "annotations_url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "title",
        "summary",
        "text",
        "annotations_count",
        "annotations_url"
      ]
    },
    "name": {
      "description": "The name of the check.",
      "example": "test-coverage",
      "type": "string"
    },
    "check_suite": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        }
      },
      "required": [
        "id"
      ],
      "nullable": true
    },
    "app": {
      "$ref": "#/components/schemas/nullable-integration"
    },
    "pull_requests": {
      "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      }
    },
    "deployment": {
      "$ref": "#/components/schemas/deployment-simple"
    }
  },
  "required": [
    "id",
    "node_id",
    "head_sha",
    "name",
    "url",
    "html_url",
    "details_url",
    "status",
    "conclusion",
    "started_at",
    "completed_at",
    "external_id",
    "check_suite",
    "output",
    "app",
    "pull_requests"
  ]
}