CheckRun
This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see the Checks preview for more details.
Note: The GraphQL resources under preview cannot be accessed via the Explorer at this time.
A check run.
Implements
Connections
CheckAnnotationConnection)
The check run's annotations
| Argument | Type | Description |
|---|---|---|
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. |
Fields
CheckSuite!)
The check suite that this run is a part of.
DateTime)
Identifies the date and time when the check run was completed.
CheckConclusionState)
The conclusion of the check run.
Int)
Identifies the primary key from the database.
URI)
The URL from which to find full details of the check run on the integrator's site.
String)
A reference for the check run on the integrator's system.
ID!)
String!)
The name of the check for this check run.
URI!)
The permalink to the check run summary.
Repository!)
The repository associated with this check run.
URI!)
The HTTP path for this check run.
DateTime)
Identifies the date and time when the check run was started.
CheckStatusState!)
The current status of the check run.
String)
A string representing the check run's summary
String)
A string representing the check run's text
String)
A string representing the check run
URI!)
The HTTP URL for this check run.
-
Overview
-
Query
-
Mutations
- acceptBusinessMemberInvitation
- acceptTopicSuggestion
- addAssigneesToAssignable
- addComment
- addLabelsToLabelable
- addProjectCard
- addProjectColumn
- addPullRequestReview
- addPullRequestReviewComment
- addReaction
- addStar
- cancelBusinessAdminInvitation
- cancelBusinessBillingManagerInvitation
- changeUserStatus
- clearLabelsFromLabelable
- closeIssue
- closePullRequest
- convertProjectCardNoteToIssue
- createBranchProtectionRule
- createCheckRun
- createCheckSuite
- createContentAttachment
- createDeployment
- createDeploymentStatus
- createIssue
- createProject
- createPullRequest
- createTeamDiscussion
- createTeamDiscussionComment
- declineTopicSuggestion
- deleteBranchProtectionRule
- deleteIssue
- deleteIssueComment
- deleteProject
- deleteProjectCard
- deleteProjectColumn
- deletePullRequestReview
- deletePullRequestReviewComment
- deleteTeamDiscussion
- deleteTeamDiscussionComment
- dismissPullRequestReview
- inviteBusinessAdmin
- inviteBusinessBillingManager
- lockLockable
- mergePullRequest
- minimizeComment
- moveProjectCard
- moveProjectColumn
- pinIssue
- regenerateBusinessIdentityProviderRecoveryCodes
- removeAssigneesFromAssignable
- removeBusinessAdmin
- removeBusinessBillingManager
- removeBusinessIdentityProvider
- removeLabelsFromLabelable
- removeOutsideCollaborator
- removeReaction
- removeStar
- reopenIssue
- reopenPullRequest
- requestReviews
- rerequestCheckSuite
- resolveReviewThread
- setBusinessIdentityProvider
- submitPullRequestReview
- unlockLockable
- unmarkIssueAsDuplicate
- unminimizeComment
- unpinIssue
- unresolveReviewThread
- updateBranchProtectionRule
- updateBusinessAllowPrivateRepositoryForkingSetting
- updateBusinessDefaultRepositoryPermissionSetting
- updateBusinessMembersCanChangeRepositoryVisibilitySetting
- updateBusinessMembersCanCreateRepositoriesSetting
- updateBusinessMembersCanDeleteIssuesSetting
- updateBusinessMembersCanDeleteRepositoriesSetting
- updateBusinessMembersCanInviteCollaboratorsSetting
- updateBusinessMembersCanUpdateProtectedBranchesSetting
- updateBusinessOrganizationProjectsSetting
- updateBusinessProfile
- updateBusinessRepositoryProjectsSetting
- updateBusinessTeamDiscussionsSetting
- updateBusinessTwoFactorAuthenticationRequiredSetting
- updateCheckRun
- updateCheckSuitePreferences
- updateIssue
- updateIssueComment
- updateProject
- updateProjectCard
- updateProjectColumn
- updatePullRequest
- updatePullRequestReview
- updatePullRequestReviewComment
- updateSubscription
- updateTeamDiscussion
- updateTeamDiscussionComment
- updateTopics
-
Objects
- AddedToProjectEvent
- App
- AssignedEvent
- BaseRefChangedEvent
- BaseRefForcePushedEvent
- Blame
- BlameRange
- Blob
- Bot
- BranchProtectionRule
- BranchProtectionRuleConflict
- Business
- BusinessAdminInfo
- BusinessBillingInfo
- BusinessIdentityProvider
- BusinessMemberInvitation
- BusinessRepositoryInfo
- CheckAnnotation
- CheckAnnotationPosition
- CheckAnnotationSpan
- CheckRun
- CheckSuite
- ClosedEvent
- CodeOfConduct
- CommentDeletedEvent
- Commit
- CommitComment
- CommitCommentThread
- ContentAttachment
- ContentReference
- ContributionCalendar
- ContributionCalendarDay
- ContributionCalendarMonth
- ContributionCalendarWeek
- ContributionsCollection
- ConvertedNoteToIssueEvent
- CreatedIssueContribution
- CreatedPullRequestContribution
- CrossReferencedEvent
- DemilestonedEvent
- DependencyGraphDependency
- DependencyGraphManifest
- DeployKey
- DeployedEvent
- Deployment
- DeploymentEnvironmentChangedEvent
- DeploymentStatus
- ExternalIdentity
- ExternalIdentitySamlAttributes
- ExternalIdentityScimAttributes
- GenericHovercardContext
- Gist
- GistComment
- GitActor
- GitHubMetadata
- GpgSignature
- HeadRefDeletedEvent
- HeadRefForcePushedEvent
- HeadRefRestoredEvent
- Hovercard
- Issue
- IssueComment
- JoinedGitHubContribution
- Label
- LabeledEvent
- Language
- License
- LicenseRule
- LockedEvent
- MarketplaceCategory
- MarketplaceListing
- MentionedEvent
- MergedEvent
- Milestone
- MilestonedEvent
- MovedColumnsInProjectEvent
- Organization
- OrganizationIdentityProvider
- OrganizationInvitation
- OrganizationTeamsHovercardContext
- OrganizationsHovercardContext
- PageInfo
- PinnedEvent
- PinnedIssue
- Project
- ProjectCard
- ProjectColumn
- ProtectedBranch
- PublicKey
- PullRequest
- PullRequestChangedFile
- PullRequestCommit
- PullRequestCommitCommentThread
- PullRequestReview
- PullRequestReviewComment
- PullRequestReviewThread
- PullRequestRevisionMarker
- Push
- PushAllowance
- RateLimit
- Reaction
- ReactionGroup
- Ref
- ReferencedEvent
- Release
- ReleaseAsset
- RemovedFromProjectEvent
- RenamedTitleEvent
- ReopenedEvent
- Repository
- RepositoryInvitation
- RepositoryTopic
- RepositoryVulnerabilityAlert
- RestrictedContribution
- ReviewDismissalAllowance
- ReviewDismissedEvent
- ReviewRequest
- ReviewRequestRemovedEvent
- ReviewRequestedEvent
- ReviewStatusHovercardContext
- SecurityAdvisory
- SecurityAdvisoryIdentifier
- SecurityAdvisoryPackage
- SecurityAdvisoryPackageVersion
- SecurityAdvisoryReference
- SecurityVulnerability
- SmimeSignature
- Status
- StatusContext
- SubscribedEvent
- SuggestedReviewer
- Tag
- Team
- TeamDiscussion
- TeamDiscussionComment
- TextMatch
- TextMatchHighlight
- Topic
- TransferredEvent
- Tree
- TreeEntry
- UnassignedEvent
- UnknownSignature
- UnlabeledEvent
- UnlockedEvent
- UnpinnedEvent
- UnsubscribedEvent
- User
- UserContentEdit
- UserStatus
- ViewerHovercardContext
-
Interfaces
- Actor
- Assignable
- Closable
- Comment
- Contribution
- Deletable
- GitObject
- GitSignature
- HovercardContext
- Labelable
- Lockable
- MemberStatusable
- Minimizable
- Node
- ProjectOwner
- Reactable
- RegistryPackageOwner
- RegistryPackageSearch
- RepositoryInfo
- RepositoryNode
- RepositoryOwner
- Starrable
- Subscribable
- UniformResourceLocatable
- Updatable
- UpdatableComment
-
Enums
- BusinessDefaultRepositoryPermissionSettingValue
- BusinessEnabledDisabledSettingValue
- BusinessEnabledSettingValue
- BusinessMemberInvitationRole
- BusinessMembersCanCreateRepositoriesSettingValue
- CheckAnnotationLevel
- CheckConclusionState
- CheckRunType
- CheckStatusState
- CollaboratorAffiliation
- CommentAuthorAssociation
- CommentCannotUpdateReason
- DefaultRepositoryPermissionField
- DeploymentOrderField
- DeploymentState
- DeploymentStatusState
- GistOrderField
- GistPrivacy
- GitSignatureState
- IssueOrderField
- IssueState
- IssueTimelineItemsItemType
- LanguageOrderField
- LockReason
- MergeStateStatus
- MergeableState
- MilestoneOrderField
- MilestoneState
- OrderDirection
- OrganizationInvitationRole
- OrganizationInvitationType
- OrganizationMemberRole
- OrganizationMembersCanCreateRepositoriesSettingValue
- OrganizationOrderField
- ProjectCardArchivedState
- ProjectCardState
- ProjectColumnPurpose
- ProjectOrderField
- ProjectState
- PullRequestOrderField
- PullRequestReviewCommentState
- PullRequestReviewEvent
- PullRequestReviewState
- PullRequestState
- PullRequestTimelineItemsItemType
- ReactionContent
- ReactionOrderField
- RefOrderField
- ReleaseOrderField
- ReportedContentClassifiers
- RepositoryAffiliation
- RepositoryContributionType
- RepositoryLockReason
- RepositoryOrderField
- RepositoryPermission
- RepositoryPrivacy
- RequestableCheckStatusState
- SamlDigestAlgorithm
- SamlSignatureAlgorithm
- SearchType
- SecurityAdvisoryEcosystem
- SecurityAdvisoryIdentifierType
- SecurityAdvisoryOrderField
- SecurityAdvisorySeverity
- SecurityVulnerabilityOrderField
- StarOrderField
- StatusState
- SubscriptionState
- TeamDiscussionCommentOrderField
- TeamDiscussionOrderField
- TeamMemberOrderField
- TeamMemberRole
- TeamMembershipType
- TeamOrderField
- TeamPrivacy
- TeamRepositoryOrderField
- TeamRole
- TopicSuggestionDeclineReason
- UserStatusOrderField
-
Unions
- Closer
- CollectionItemContent
- CreatedIssueOrRestrictedContribution
- CreatedPullRequestOrRestrictedContribution
- IssueOrPullRequest
- IssueTimelineItem
- IssueTimelineItems
- MilestoneItem
- ProjectCardItem
- PullRequestTimelineItem
- PullRequestTimelineItems
- PushAllowanceActor
- ReferencedSubject
- RenamedTitleSubject
- RequestedReviewer
- ReviewDismissalAllowanceActor
- SearchResultItem
-
Input Objects
- CheckAnnotationData
- CheckAnnotationRange
- CheckRunAction
- CheckRunFilter
- CheckRunOutput
- CheckRunOutputImage
- CheckSuiteAutoTriggerPreference
- CheckSuiteFilter
- CommitAuthor
- DeploymentOrder
- DraftPullRequestReviewComment
- GistOrder
- IssueFilters
- IssueOrder
- LanguageOrder
- MilestoneOrder
- OrganizationOrder
- ProjectOrder
- ReactionOrder
- RefOrder
- ReleaseOrder
- RepositoryOrder
- SecurityAdvisoryIdentifierFilter
- SecurityAdvisoryOrder
- SecurityVulnerabilityOrder
- StarOrder
- TeamDiscussionCommentOrder
- TeamDiscussionOrder
- TeamMemberOrder
- TeamOrder
- TeamRepositoryOrder
- UserStatusOrder
-
Scalars