Github API - Test Config

UpdateCheckRunInput [input]

Autogenerated input type of UpdateCheckRun

Attributes
actions CheckRunAction []

CheckRunAction [input]

Possible further actions the integrator can perform.

Attributes
description String

A short explanation of what this action would do.

identifier String

A reference for the action on the integrator's system.

label String

The text to be displayed on a button in the web UI.

API:
Github GraphQL API

Possible further actions the integrator can perform, which a user may trigger.

checkRunId ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The node of the check.

clientMutationId String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

A unique identifier for the client performing the mutation.

completedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

The time that the check run finished.

conclusion CheckConclusionState

CheckConclusionState [enum]

The possible states for a check suite or run conclusion.

Possible values
ACTION_REQUIRED

The check suite or run requires action.

CANCELLED

The check suite or run has been cancelled.

FAILURE

The check suite or run has failed.

NEUTRAL

The check suite or run was neutral.

SKIPPED

The check suite or run was skipped.

STALE

The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.

STARTUP_FAILURE

The check suite or run has failed at startup.

SUCCESS

The check suite or run has succeeded.

TIMED_OUT

The check suite or run has timed out.

API:
Github GraphQL API

The final conclusion of the check.

detailsUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The URL of the integrator's site that has the full details of the check.

externalId String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

A reference for the run on the integrator's system.

name String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The name of the check.

output CheckRunOutput

CheckRunOutput [input]

Descriptive details about the check run.

Attributes
annotations CheckAnnotationData []

The annotations that are made as part of the check run.

Images attached to the check run output displayed in the GitHub pull request UI.

summary String

The summary of the check run (supports Commonmark).

text String

The details of the check run (supports Commonmark).

title String

A title to provide for this check run.

API:
Github GraphQL API

Descriptive details about the run.

repositoryId ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The node ID of the repository.

startedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

The time that the check run began.

status RequestableCheckStatusState

RequestableCheckStatusState [enum]

The possible states that can be requested when creating a check run.

Possible values
COMPLETED

The check suite or run has been completed.

IN_PROGRESS

The check suite or run is in progress.

PENDING

The check suite or run is in pending state.

QUEUED

The check suite or run has been queued.

WAITING

The check suite or run is in waiting state.

API:
Github GraphQL API

The current status.

API:
Github GraphQL API