Github API - Test Config

CheckRun [object]

A check run.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
RequirableByPullRequest

RequirableByPullRequest [interface]

Represents a type that can be required by a pull request for merging.

Attributes
isRequired Boolean

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

API:
Github GraphQL API
UniformResourceLocatable

UniformResourceLocatable [interface]

Represents a type that can be retrieved by a URL.

Attributes
resourcePath URI

The HTML path to this resource.

url URI

The URL to this resource.

API:
Github GraphQL API
Attributes
annotations CheckAnnotationConnection

CheckAnnotationConnection [object]

The connection type for CheckAnnotation.

Attributes

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.

API:
Github GraphQL API

The check run's annotations

checkSuite CheckSuite

CheckSuite [object]

A check suite.

Implements
Node
Attributes
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.

commit Commit

The commit for this check suite

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.

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

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.

API:
Github GraphQL API

The check suite that this run is a part of.

completedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

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

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 conclusion of the check run.

databaseId Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Identifies the primary key from the database.

deployment Deployment

Deployment [object]

Represents triggered deployment instance.

Implements
Node
Attributes
commit Commit

Identifies the commit sha of the deployment.

commitOid String

Identifies the oid of the deployment commit, even if the commit has been deleted.

createdAt DateTime

Identifies the date and time when the object was created.

creator Actor

Identifies the actor who triggered the deployment.

databaseId Int

Identifies the primary key from the database.

description String

The deployment description.

environment String

The latest environment to which this deployment was made.

id ID

The Node ID of the Deployment object

latestEnvironment String

The latest environment to which this deployment was made.

latestStatus DeploymentStatus

The latest status of this deployment.

originalEnvironment String

The original environment to which this deployment was made.

payload String

Extra information that a deployment system might need.

ref Ref

Identifies the Ref of the deployment, if the deployment was created by ref.

repository Repository

Identifies the repository associated with the deployment.

The current state of the deployment.

A list of statuses associated with the deployment.

task String

The deployment task.

updatedAt DateTime

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

API:
Github GraphQL API

The corresponding deployment for this job, if any

detailsUrl URI

URI [scalar]

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

API:
Github GraphQL API

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

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 check run on the integrator's system.

id 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 CheckRun object

isRequired Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

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

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 for this check run.

pendingDeploymentRequest DeploymentRequest

DeploymentRequest [object]

A request to deploy a workflow run to an environment.

Attributes
currentUserCanApprove Boolean

Whether or not the current user can approve the deployment

environment Environment

The target environment of the deployment

The teams or users that can review the deployment

waitTimer Int

The wait timer in minutes configured in the environment

waitTimerStartedAt DateTime

The wait timer in minutes configured in the environment

API:
Github GraphQL API

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

permalink URI

URI [scalar]

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

API:
Github GraphQL API

The permalink to the check run summary.

repository Repository

Repository [object]

A repository contains the content for a project.

Implements
NodePackageOwnerProjectOwnerProjectV2RecentRepositoryInfoStarrableSubscribableUniformResourceLocatable
Attributes
allowUpdateBranch Boolean

Whether or not a pull request head branch that is behind its base branch can
always be updated even if it is not required to be up to date before merging.

archivedAt DateTime

Identifies the date and time when the repository was archived.

assignableUsers UserConnection

A list of users that can be assigned to issues in this repository.

autoMergeAllowed Boolean

Whether or not Auto-merge can be enabled on pull requests in this repository.

branchProtectionRules BranchProtectionRuleConnection

A list of branch protection rules for this repository.

codeOfConduct CodeOfConduct

Returns the code of conduct for this repository

Information extracted from the repository's CODEOWNERS file.

A list of collaborators associated with the repository.

commitComments CommitCommentConnection

A list of commit comments associated with the repository.

contactLinks RepositoryContactLink []

Returns a list of contact links associated to the repository

contributingGuidelines ContributingGuidelines

Returns the contributing guidelines for this repository.

createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

defaultBranchRef Ref

The Ref associated with the repository's default branch.

deleteBranchOnMerge Boolean

Whether or not branches are automatically deleted when merged in this repository.

dependencyGraphManifests DependencyGraphManifestConnection

A list of dependency manifests contained in the repository

deployKeys DeployKeyConnection

A list of deploy keys that are on this repository.

deployments DeploymentConnection

Deployments associated with the repository

description String

The description of the repository.

descriptionHTML HTML

The description of the repository rendered to HTML.

discussion Discussion

Returns a single discussion from the current repository by number.

discussionCategories DiscussionCategoryConnection

A list of discussion categories that are available in the repository.

discussionCategory DiscussionCategory

A discussion category by slug.

discussions DiscussionConnection

A list of discussions that have been opened in the repository.

diskUsage Int

The number of kilobytes this repository occupies on disk.

environment Environment

Returns a single active environment from the current repository by name.

environments EnvironmentConnection

A list of environments that are in this repository.

forkCount Int

Returns how many forks there are of this repository in the whole network.

forkingAllowed Boolean

Whether this repository allows forks.

A list of direct forked repositories.

fundingLinks FundingLink []

The funding links for this repository

hasDiscussionsEnabled Boolean

Indicates if the repository has the Discussions feature enabled.

hasIssuesEnabled Boolean

Indicates if the repository has issues feature enabled.

hasProjectsEnabled Boolean

Indicates if the repository has the Projects feature enabled.

hasSponsorshipsEnabled Boolean

Indicates if the repository displays a Sponsor button for financial contributions.

hasVulnerabilityAlertsEnabled Boolean

Whether vulnerability alerts are enabled for the repository.

hasWikiEnabled Boolean

Indicates if the repository has wiki feature enabled.

homepageUrl URI

The repository's URL.

id ID

The Node ID of the Repository object

interactionAbility RepositoryInteractionAbility

The interaction ability settings for this repository.

isArchived Boolean

Indicates if the repository is unmaintained.

isBlankIssuesEnabled Boolean

Returns true if blank issue creation is allowed

isDisabled Boolean

Returns whether or not this repository disabled.

isEmpty Boolean

Returns whether or not this repository is empty.

isFork Boolean

Identifies if the repository is a fork.

isInOrganization Boolean

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

isLocked Boolean

Indicates if the repository has been locked or not.

isMirror Boolean

Identifies if the repository is a mirror.

isPrivate Boolean

Identifies if the repository is private or internal.

isSecurityPolicyEnabled Boolean

Returns true if this repository has a security policy

isTemplate Boolean

Identifies if the repository is a template that can be used to generate new repositories.

isUserConfigurationRepository Boolean

Is this repository a user configuration repository?

issue Issue

Returns a single issue from the current repository by number.

issueOrPullRequest IssueOrPullRequest

Returns a single issue-like object from the current repository by number.

issueTemplates IssueTemplate []

Returns a list of issue templates associated to the repository

A list of issues that have been opened in the repository.

label Label

Returns a single label by name

A list of labels associated with the repository.

languages LanguageConnection

A list containing a breakdown of the language composition of the repository.

latestRelease Release

Get the latest release for the repository if one exists.

licenseInfo License

The license associated with the repository

The reason the repository has been locked.

mentionableUsers UserConnection

A list of Users that can be mentioned in the context of the repository.

mergeCommitAllowed Boolean

Whether or not PRs are merged with a merge commit on this repository.

mergeCommitMessage MergeCommitMessage

How the default commit message will be generated when merging a pull request.

mergeCommitTitle MergeCommitTitle

How the default commit title will be generated when merging a pull request.

mergeQueue MergeQueue

The merge queue for a specified branch, otherwise the default branch if not provided.

milestone Milestone

Returns a single milestone from the current repository by number.

milestones MilestoneConnection

A list of milestones associated with the repository.

mirrorUrl URI

The repository's original mirror URL.

name String

The name of the repository.

nameWithOwner String

The repository's name with owner.

object GitObject

A Git object in the repository

openGraphImageUrl URI

The image used to represent this repository in Open Graph data.

The User owner of the repository.

A list of packages under the owner.

parent Repository

The repository parent, if this is a fork.

pinnedDiscussions PinnedDiscussionConnection

A list of discussions that have been pinned in this repository.

pinnedIssues PinnedIssueConnection

A list of pinned issues for this repository.

primaryLanguage Language

The primary language of the repository's code.

project Project

Find project by number.

projectV2 ProjectV2

Finds and returns the Project according to the provided Project number.

A list of projects under the owner.

projectsResourcePath URI

The HTTP path listing the repository's projects

projectsUrl URI

The HTTP URL listing the repository's projects

projectsV2 ProjectV2Connection

List of projects linked to this repository.

pullRequest PullRequest

Returns a single pull request from the current repository by number.

pullRequestTemplates PullRequestTemplate []

Returns a list of pull request templates associated to the repository

pullRequests PullRequestConnection

A list of pull requests that have been opened in the repository.

pushedAt DateTime

Identifies the date and time when the repository was last pushed to.

rebaseMergeAllowed Boolean

Whether or not rebase-merging is enabled on this repository.

recentProjects ProjectV2Connection

Recent projects that this user has modified in the context of the owner.

ref Ref

Fetch a given ref from the repository

Fetch a list of refs from the repository

release Release

Lookup a single release given various criteria.

List of releases which are dependent on this repository.

repositoryTopics RepositoryTopicConnection

A list of applied repository-topic associations for this repository.

resourcePath URI

The HTTP path for this repository

Returns a single ruleset from the current repository by ID.

A list of rulesets for this repository.

securityPolicyUrl URI

The security policy URL.

shortDescriptionHTML HTML

A description of the repository, rendered to HTML without any links in it.

squashMergeAllowed Boolean

Whether or not squash-merging is enabled on this repository.

squashMergeCommitMessage SquashMergeCommitMessage

How the default commit message will be generated when squash merging a pull request.

squashMergeCommitTitle SquashMergeCommitTitle

How the default commit title will be generated when squash merging a pull request.

squashPrTitleUsedAsDefault Boolean

Whether a squash merge commit can use the pull request title as default.

Deprecated: `squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle` instead. Removal on 2023-04-01 UTC.
sshUrl GitSSHRemote

The SSH URL to clone this repository

stargazerCount Int

Returns a count of how many stargazers there are on this object

stargazers StargazerConnection

A list of users who have starred this starrable.

submodules SubmoduleConnection

Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.

tempCloneToken String

Temporary authentication token for cloning this repository.

templateRepository Repository

The repository from which this repository was generated, if any.

updatedAt DateTime

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

url URI

The HTTP URL for this repository

usesCustomOpenGraphImage Boolean

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

viewerCanAdminister Boolean

Indicates whether the viewer has admin permissions on this repository.

viewerCanCreateProjects Boolean

Can the current viewer create new projects on this owner.

viewerCanSubscribe Boolean

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdateTopics Boolean

Indicates whether the viewer can update the topics of this repository.

viewerDefaultCommitEmail String

The last commit email for the viewer.

viewerDefaultMergeMethod PullRequestMergeMethod

The last used merge method by the viewer or the default for the repository.

viewerHasStarred Boolean

Returns a boolean indicating whether the viewing user has starred this starrable.

viewerPermission RepositoryPermission

The users permission level on the repository. Will return null if authenticated as an GitHub App.

viewerPossibleCommitEmails String []

A list of emails this viewer can commit with.

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

Indicates the repository's visibility level.

vulnerabilityAlert RepositoryVulnerabilityAlert

Returns a single vulnerability alert from the current repository by number.

A list of vulnerability alerts that are on this repository.

watchers UserConnection

A list of users watching the repository.

webCommitSignoffRequired Boolean

Whether contributors are required to sign off on web-based commits in this repository.

API:
Github GraphQL API

The repository associated with this check run.

resourcePath URI

URI [scalar]

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

API:
Github GraphQL API

The HTTP path for this check run.

startedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

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

status CheckStatusState

CheckStatusState [enum]

The possible states for a check suite or run status.

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.

REQUESTED

The check suite or run has been requested.

WAITING

The check suite or run is in waiting state.

API:
Github GraphQL API

The current status of the check run.

steps CheckStepConnection

CheckStepConnection [object]

The connection type for CheckStep.

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

API:
Github GraphQL API

The check run's steps

summary 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 string representing the check run's summary

text 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 string representing the check run's text

title 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 string representing the check run

url URI

URI [scalar]

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

API:
Github GraphQL API

The HTTP URL for this check run.

API:
Github GraphQL API