Reference documentation for GraphQL schema types in the Checks category.

Dans cet article

Mutations

createCheckRun

Mutation

Create a check run.

Champs d’entrée pour createCheckRun

Champs de retour pour createCheckRun

NomDescription

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Mutation

Create a check suite.

Champs d’entrée pour createCheckSuite

Champs de retour pour createCheckSuite

NomDescription

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

rerequestCheckSuite

Mutation

Rerequests an existing check suite.

Champs d’entrée pour rerequestCheckSuite

Champs de retour pour rerequestCheckSuite

NomDescription

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckRun

Mutation

Update a check run.

Champs d’entrée pour updateCheckRun

Champs de retour pour updateCheckRun

NomDescription

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckSuitePreferences

Mutation

Modifies the settings of an existing check suite.

Champs d’entrée pour updateCheckSuitePreferences

Champs de retour pour updateCheckSuitePreferences

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

Objects

CheckAnnotation

Object

A single check annotation.

Champs pour CheckAnnotation

NomDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

blobUrl (URI!)

The path to the file that this annotation was made on.

databaseId (Int)

Identifies the primary key from the database.

Avertissement

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2027-01-01 UTC.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

location (CheckAnnotationSpan!)

The position of this annotation.

message (String!)

The annotation's message.

path (String!)

The path that this annotation was made on.

rawDetails (String)

Additional information about the annotation.

title (String)

The annotation's title.

CheckAnnotationConnection

Object

The connection type for CheckAnnotation.

Champs pour CheckAnnotationConnection

NomDescription

edges ([CheckAnnotationEdge])

A list of edges.

nodes ([CheckAnnotation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckAnnotationEdge

Object

An edge in a connection.

Champs pour CheckAnnotationEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (CheckAnnotation)

The item at the end of the edge.

CheckAnnotationPosition

Object

A character position in a check annotation.

Champs pour CheckAnnotationPosition

NomDescription

column (Int)

Column number (1 indexed).

line (Int!)

Line number (1 indexed).

CheckAnnotationSpan

Object

An inclusive pair of positions for a check annotation.

Champs pour CheckAnnotationSpan

NomDescription

end (CheckAnnotationPosition!)

End position (inclusive).

start (CheckAnnotationPosition!)

Start position (inclusive).

CheckRun

Object

A check run.

CheckRun Met en œuvre

Champs pour CheckRun

NomDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

Arguments pour annotations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

checkSuite (CheckSuite!)

The check suite that this run is a part of.

completedAt (DateTime)

Identifies the date and time when the check run was completed.

conclusion (CheckConclusionState)

The conclusion of the check run.

databaseId (Int)

Identifies the primary key from the database.

deployment (Deployment)

The corresponding deployment for this job, if any.

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

externalId (String)

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

id (ID!)

The Node ID of the CheckRun object.

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

Arguments pour isRequired

  • pullRequestId (ID)

    The id of the pull request this is required for.

  • pullRequestNumber (Int)

    The number of the pull request this is required for.

name (String!)

The name of the check for this check run.

pendingDeploymentRequest (DeploymentRequest)

Information about a pending deployment, if any, in this check run.

permalink (URI!)

The permalink to the check run summary.

repository (Repository!)

The repository associated with this check run.

resourcePath (URI!)

The HTTP path for this check run.

startedAt (DateTime)

Identifies the date and time when the check run was started.

status (CheckStatusState!)

The current status of the check run.

steps (CheckStepConnection)

The check run's steps.

Arguments pour steps

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • number (Int)

    Step number.

summary (String)

A string representing the check run's summary.

text (String)

A string representing the check run's text.

title (String)

A string representing the check run.

url (URI!)

The HTTP URL for this check run.

CheckRunConnection

Object

The connection type for CheckRun.

Champs pour CheckRunConnection

NomDescription

edges ([CheckRunEdge])

A list of edges.

nodes ([CheckRun])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckRunEdge

Object

An edge in a connection.

Champs pour CheckRunEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (CheckRun)

The item at the end of the edge.

CheckRunStateCount

Object

Represents a count of the state of a check run.

Champs pour CheckRunStateCount

NomDescription

count (Int!)

The number of check runs with this state.

state (CheckRunState!)

The state of a check run.

CheckStep

Object

A single check step.

Champs pour CheckStep

NomDescription

completedAt (DateTime)

Identifies the date and time when the check step was completed.

conclusion (CheckConclusionState)

The conclusion of the check step.

externalId (String)

A reference for the check step on the integrator's system.

name (String!)

The step's name.

number (Int!)

The index of the step in the list of steps of the parent check run.

secondsToCompletion (Int)

Number of seconds to completion.

startedAt (DateTime)

Identifies the date and time when the check step was started.

status (CheckStatusState!)

The current status of the check step.

CheckStepConnection

Object

The connection type for CheckStep.

Champs pour CheckStepConnection

NomDescription

edges ([CheckStepEdge])

A list of edges.

nodes ([CheckStep])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckStepEdge

Object

An edge in a connection.

Champs pour CheckStepEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (CheckStep)

The item at the end of the edge.

CheckSuite

Object

A check suite.

CheckSuite Met en œuvre

Champs pour CheckSuite

NomDescription

app (App)

The GitHub App which created this check suite.

branch (Ref)

The name of the branch for this check suite.

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

Arguments pour checkRuns

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit!)

The commit for this check suite.

conclusion (CheckConclusionState)

The conclusion of this check suite.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (User)

The user who triggered the check suite.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the CheckSuite object.

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

Arguments pour matchingPullRequests

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • baseRefName (String)

    The base ref name to filter the pull requests by.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • headRefName (String)

    The head ref name to filter the pull requests by.

  • labels ([String!])

    A list of label names to filter the pull requests by.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (IssueOrder)

    Ordering options for pull requests returned from the connection.

push (Push)

The push that triggered this check suite.

repository (Repository!)

The repository associated with this check suite.

resourcePath (URI!)

The HTTP path for this check suite.

status (CheckStatusState!)

The status of this check suite.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this check suite.

workflowRun (WorkflowRun)

The workflow run associated with this check suite.

CheckSuiteConnection

Object

The connection type for CheckSuite.

Champs pour CheckSuiteConnection

NomDescription

edges ([CheckSuiteEdge])

A list of edges.

nodes ([CheckSuite])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckSuiteEdge

Object

An edge in a connection.

Champs pour CheckSuiteEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (CheckSuite)

The item at the end of the edge.

Enums

CheckAnnotationLevel

Enum

Represents an annotation's information level.

Valeurs pour CheckAnnotationLevel.

NomDescription
FAILURE

An annotation indicating an inescapable error.

NOTICE

An annotation indicating some information.

WARNING

An annotation indicating an ignorable error.

CheckConclusionState

Enum

The possible states for a check suite or run conclusion.

Valeurs pour CheckConclusionState.

NomDescription
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.

CheckRunState

Enum

The possible states of a check run in a status rollup.

Valeurs pour CheckRunState.

NomDescription
ACTION_REQUIRED

The check run requires action.

CANCELLED

The check run has been cancelled.

COMPLETED

The check run has been completed.

FAILURE

The check run has failed.

IN_PROGRESS

The check run is in progress.

NEUTRAL

The check run was neutral.

PENDING

The check run is in pending state.

QUEUED

The check run has been queued.

SKIPPED

The check run was skipped.

STALE

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

STARTUP_FAILURE

The check run has failed at startup.

SUCCESS

The check run has succeeded.

TIMED_OUT

The check run has timed out.

WAITING

The check run is in waiting state.

CheckRunType

Enum

The possible types of check runs.

Valeurs pour CheckRunType.

NomDescription
ALL

Every check run available.

LATEST

The latest check run.

CheckStatusState

Enum

The possible states for a check suite or run status.

Valeurs pour CheckStatusState.

NomDescription
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.

REQUESTED

The check suite or run has been requested.

WAITING

The check suite or run is in waiting state.

RequestableCheckStatusState

Enum

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

Valeurs pour RequestableCheckStatusState.

NomDescription
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.

Input objects

CheckAnnotationData

Input object

Information from a check run analysis to specific lines of code.

Champs d’entrée pour CheckAnnotationData

NomDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

location (CheckAnnotationRange!)

The location of the annotation.

message (String!)

A short description of the feedback for these lines of code.

path (String!)

The path of the file to add an annotation to.

rawDetails (String)

Details about this annotation.

title (String)

The title that represents the annotation.

CheckAnnotationRange

Input object

Information from a check run analysis to specific lines of code.

Champs d’entrée pour CheckAnnotationRange

NomDescription

endColumn (Int)

The ending column of the range.

endLine (Int!)

The ending line of the range.

startColumn (Int)

The starting column of the range.

startLine (Int!)

The starting line of the range.

CheckRunAction

Input object

Possible further actions the integrator can perform.

Champs d’entrée pour CheckRunAction

NomDescription

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.

CheckRunFilter

Input object

The filters that are available when fetching check runs.

Champs d’entrée pour CheckRunFilter

NomDescription

appId (Int)

Filters the check runs created by this application ID.

checkName (String)

Filters the check runs by this name.

checkType (CheckRunType)

Filters the check runs by this type.

conclusions ([CheckConclusionState!])

Filters the check runs by these conclusions.

status (CheckStatusState)

Filters the check runs by this status. Superceded by statuses.

statuses ([CheckStatusState!])

Filters the check runs by this status. Overrides status.

CheckRunOutput

Input object

Descriptive details about the check run.

Champs d’entrée pour CheckRunOutput

NomDescription

annotations ([CheckAnnotationData!])

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

images ([CheckRunOutputImage!])

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.

CheckRunOutputImage

Input object

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

Champs d’entrée pour CheckRunOutputImage

NomDescription

alt (String!)

The alternative text for the image.

caption (String)

A short image description.

imageUrl (URI!)

The full URL of the image.

CheckSuiteAutoTriggerPreference

Input object

The auto-trigger preferences that are available for check suites.

Champs d’entrée pour CheckSuiteAutoTriggerPreference

NomDescription

appId (ID!)

The node ID of the application that owns the check suite.

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

CheckSuiteFilter

Input object

The filters that are available when fetching check suites.

Champs d’entrée pour CheckSuiteFilter

NomDescription

appId (Int)

Filters the check suites created by this application ID.

checkName (String)

Filters the check suites by this name.

CreateCheckRunInput

Input object

Autogenerated input type of CreateCheckRun.

Champs d’entrée pour CreateCheckRunInput

NomDescription

actions ([CheckRunAction!])

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

clientMutationId (String)

A unique identifier for the client performing the mutation.

completedAt (DateTime)

The time that the check run finished.

conclusion (CheckConclusionState)

The final conclusion of the check.

detailsUrl (URI)

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

externalId (String)

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

headSha (GitObjectID!)

The SHA of the head commit.

name (String!)

The name of the check.

output (CheckRunOutput)

Descriptive details about the run.

repositoryId (ID!)

The node ID of the repository.

startedAt (DateTime)

The time that the check run began.

status (RequestableCheckStatusState)

The current status.

CreateCheckSuiteInput

Input object

Autogenerated input type of CreateCheckSuite.

Champs d’entrée pour CreateCheckSuiteInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

headSha (GitObjectID!)

The SHA of the head commit.

repositoryId (ID!)

The Node ID of the repository.

RerequestCheckSuiteInput

Input object

Autogenerated input type of RerequestCheckSuite.

Champs d’entrée pour RerequestCheckSuiteInput

NomDescription

checkSuiteId (ID!)

The Node ID of the check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

UpdateCheckRunInput

Input object

Autogenerated input type of UpdateCheckRun.

Champs d’entrée pour UpdateCheckRunInput

NomDescription

actions ([CheckRunAction!])

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

checkRunId (ID!)

The node of the check.

clientMutationId (String)

A unique identifier for the client performing the mutation.

completedAt (DateTime)

The time that the check run finished.

conclusion (CheckConclusionState)

The final conclusion of the check.

detailsUrl (URI)

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

externalId (String)

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

name (String)

The name of the check.

output (CheckRunOutput)

Descriptive details about the run.

repositoryId (ID!)

The node ID of the repository.

startedAt (DateTime)

The time that the check run began.

status (RequestableCheckStatusState)

The current status.

UpdateCheckSuitePreferencesInput

Input object

Autogenerated input type of UpdateCheckSuitePreferences.

Champs d’entrée pour UpdateCheckSuitePreferencesInput

NomDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.