CheckRun [object]
A check run.
Implements
RequirableByPullRequest [interface]
Represents a type that can be required by a pull request for merging.
Attributes
Whether this is required to pass before merging for a specific pull request.
Attributes
CheckAnnotationConnection [object]
The connection type for CheckAnnotation.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The check run's annotations
CheckSuite [object]
A check suite.
Implements
Attributes
The GitHub App which created this check suite.
The name of the branch for this check suite.
The check runs associated with a check suite.
The commit for this check suite
The conclusion of this check suite.
Identifies the date and time when the object was created.
The user who triggered the check suite.
Identifies the primary key from the database.
The Node ID of the CheckSuite object
A list of open pull requests matching the check suite.
The push that triggered this check suite.
The repository associated with this check suite.
The HTTP path for this check suite
The status of this check suite.
Identifies the date and time when the object was last updated.
The HTTP URL for this check suite
The workflow run associated with this check suite.
The check suite that this run is a part of.
Identifies the date and time when the check run was completed.
CheckConclusionState [enum]
The possible states for a check suite or run conclusion.
Possible values
The check suite or run requires action.
The check suite or run has been cancelled.
The check suite or run has failed.
The check suite or run was neutral.
The check suite or run was skipped.
The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.
The check suite or run has failed at startup.
The check suite or run has succeeded.
The check suite or run has timed out.
The conclusion of the check run.
Int [scalar]
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Identifies the primary key from the database.
Deployment [object]
Represents triggered deployment instance.
Implements
Attributes
Identifies the commit sha of the deployment.
Identifies the oid of the deployment commit, even if the commit has been deleted.
Identifies the date and time when the object was created.
Identifies the actor who triggered the deployment.
Identifies the primary key from the database.
The deployment description.
The latest environment to which this deployment was made.
The Node ID of the Deployment object
The latest environment to which this deployment was made.
The latest status of this deployment.
The original environment to which this deployment was made.
Extra information that a deployment system might need.
Identifies the Ref of the deployment, if the deployment was created by ref.
Identifies the repository associated with the deployment.
The current state of the deployment.
A list of statuses associated with the deployment.
The deployment task.
Identifies the date and time when the object was last updated.
The corresponding deployment for this job, if any
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The URL from which to find full details of the check run on the integrator's site.
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.
A reference for the check run on the integrator's system.
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.
The Node ID of the CheckRun object
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether this is required to pass before merging for a specific pull request.
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.
The name of the check for this check run.
DeploymentRequest [object]
A request to deploy a workflow run to an environment.
Attributes
Whether or not the current user can approve the deployment
The target environment of the deployment
The teams or users that can review the deployment
The wait timer in minutes configured in the environment
The wait timer in minutes configured in the environment
Information about a pending deployment, if any, in this check run
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The permalink to the check run summary.
Repository [object]
A repository contains the content for a project.
Implements
Attributes
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.
Identifies the date and time when the repository was archived.
A list of users that can be assigned to issues in this repository.
Whether or not Auto-merge can be enabled on pull requests in this repository.
A list of branch protection rules for this repository.
Returns the code of conduct for this repository
Information extracted from the repository's CODEOWNERS
file.
A list of collaborators associated with the repository.
A list of commit comments associated with the repository.
Returns a list of contact links associated to the repository
Returns the contributing guidelines for this repository.
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The Ref associated with the repository's default branch.
Whether or not branches are automatically deleted when merged in this repository.
A list of dependency manifests contained in the repository
A list of deploy keys that are on this repository.
Deployments associated with the repository
The description of the repository.
The description of the repository rendered to HTML.
Returns a single discussion from the current repository by number.
A list of discussion categories that are available in the repository.
A discussion category by slug.
A list of discussions that have been opened in the repository.
The number of kilobytes this repository occupies on disk.
Returns a single active environment from the current repository by name.
A list of environments that are in this repository.
Returns how many forks there are of this repository in the whole network.
Whether this repository allows forks.
A list of direct forked repositories.
The funding links for this repository
Indicates if the repository has the Discussions feature enabled.
Indicates if the repository has issues feature enabled.
Indicates if the repository has the Projects feature enabled.
Indicates if the repository displays a Sponsor button for financial contributions.
Whether vulnerability alerts are enabled for the repository.
Indicates if the repository has wiki feature enabled.
The repository's URL.
The Node ID of the Repository object
The interaction ability settings for this repository.
Indicates if the repository is unmaintained.
Returns true if blank issue creation is allowed
Returns whether or not this repository disabled.
Returns whether or not this repository is empty.
Identifies if the repository is a fork.
Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
Indicates if the repository has been locked or not.
Identifies if the repository is a mirror.
Identifies if the repository is private or internal.
Returns true if this repository has a security policy
Identifies if the repository is a template that can be used to generate new repositories.
Is this repository a user configuration repository?
Returns a single issue from the current repository by number.
Returns a single issue-like object from the current repository by number.
Returns a list of issue templates associated to the repository
A list of issues that have been opened in the repository.
Returns a single label by name
A list of labels associated with the repository.
A list containing a breakdown of the language composition of the repository.
Get the latest release for the repository if one exists.
The license associated with the repository
The reason the repository has been locked.
A list of Users that can be mentioned in the context of the repository.
Whether or not PRs are merged with a merge commit on this repository.
How the default commit message will be generated when merging a pull request.
How the default commit title will be generated when merging a pull request.
The merge queue for a specified branch, otherwise the default branch if not provided.
Returns a single milestone from the current repository by number.
A list of milestones associated with the repository.
The repository's original mirror URL.
The name of the repository.
The repository's name with owner.
A Git object in the repository
The image used to represent this repository in Open Graph data.
The User owner of the repository.
A list of packages under the owner.
The repository parent, if this is a fork.
A list of discussions that have been pinned in this repository.
A list of pinned issues for this repository.
The primary language of the repository's code.
Find project by number.
Finds and returns the Project according to the provided Project number.
A list of projects under the owner.
The HTTP path listing the repository's projects
The HTTP URL listing the repository's projects
List of projects linked to this repository.
Returns a single pull request from the current repository by number.
Returns a list of pull request templates associated to the repository
A list of pull requests that have been opened in the repository.
Identifies the date and time when the repository was last pushed to.
Whether or not rebase-merging is enabled on this repository.
Recent projects that this user has modified in the context of the owner.
Fetch a given ref from the repository
Fetch a list of refs from the repository
Lookup a single release given various criteria.
List of releases which are dependent on this repository.
A list of applied repository-topic associations for this repository.
The HTTP path for this repository
Returns a single ruleset from the current repository by ID.
A list of rulesets for this repository.
The security policy URL.
A description of the repository, rendered to HTML without any links in it.
Whether or not squash-merging is enabled on this repository.
How the default commit message will be generated when squash merging a pull request.
How the default commit title will be generated when squash merging a pull request.
Whether a squash merge commit can use the pull request title as default.
The SSH URL to clone this repository
Returns a count of how many stargazers there are on this object
A list of users who have starred this starrable.
Returns a list of all submodules in this repository parsed from the
.gitmodules file as of the default branch's HEAD commit.
Temporary authentication token for cloning this repository.
The repository from which this repository was generated, if any.
Identifies the date and time when the object was last updated.
The HTTP URL for this repository
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
Indicates whether the viewer has admin permissions on this repository.
Can the current viewer create new projects on this owner.
Check if the viewer is able to change their subscription status for the repository.
Indicates whether the viewer can update the topics of this repository.
The last commit email for the viewer.
The last used merge method by the viewer or the default for the repository.
Returns a boolean indicating whether the viewing user has starred this starrable.
The users permission level on the repository. Will return null if authenticated as an GitHub App.
A list of emails this viewer can commit with.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Indicates the repository's visibility level.
Returns a single vulnerability alert from the current repository by number.
A list of vulnerability alerts that are on this repository.
A list of users watching the repository.
Whether contributors are required to sign off on web-based commits in this repository.
The repository associated with this check run.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for this check run.
Identifies the date and time when the check run was started.
CheckStatusState [enum]
The possible states for a check suite or run status.
Possible values
The check suite or run has been completed.
The check suite or run is in progress.
The check suite or run is in pending state.
The check suite or run has been queued.
The check suite or run has been requested.
The check suite or run is in waiting state.
The current status of the check run.
CheckStepConnection [object]
The connection type for CheckStep.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The check run's steps
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.
A string representing the check run's summary
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.
A string representing the check run's text
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.
A string representing the check run
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for this check run.