Deployment [object]
Represents triggered deployment instance.
Implements
Attributes
Commit [object]
Represents a Git commit.
Implements
Attributes
An abbreviated version of the Git object ID
The number of additions in this commit.
The merged Pull Request that introduced the commit to the repository. If the
commit is not present in the default branch, additionally returns open Pull
Requests associated with the commit
Authorship details of the commit.
Check if the committer and the author match.
The datetime when this commit was authored.
The list of authors for this commit based on the git author and the Co-authored-by
message trailer. The git author will always be first.
Fetches git blame information.
We recommend using the changedFilesIfAvailable field instead ofchangedFiles, as changedFiles will cause your request to return an error
if GitHub is unable to calculate the number of changed files.
The number of changed files in this commit. If GitHub is unable to calculate
the number of changed files (for example due to a timeout), this will returnnull. We recommend using this field instead of changedFiles.
The check suites associated with a commit.
Comments made on the commit.
The HTTP path for this Git object
The HTTP URL for this Git object
The datetime when this commit was committed.
Check if committed via GitHub web UI.
Committer details of the commit.
The number of deletions in this commit.
The deployments associated with a commit.
The tree entry representing the file located at the given path.
The linear commit history starting from (and including) this commit, in the same order as git log.
The Node ID of the Commit object
The Git commit message
The Git commit message body
The commit message body rendered to HTML.
The Git commit message headline
The commit message headline rendered to HTML.
The Git object ID
The organization this commit was made on behalf of.
The parents of a commit.
The datetime when this commit was pushed.
The Repository this commit belongs to
The HTTP path for this commit
Commit signing information, if present.
Status information for this commit
Check and Status rollup information for this commit.
Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
Commit's root Tree
The HTTP path for the tree of this commit
The HTTP URL for the tree of this commit
The HTTP URL for this commit
Check if the viewer is able to change their subscription status for the repository.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
Identifies the commit sha of the deployment.
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.
Identifies the oid of the deployment commit, even if the commit has been deleted.
Identifies the date and time when the object was created.
Actor [interface]
Represents an object which can take actions on GitHub. Typically a User or Bot.
Attributes
A URL pointing to the actor's public avatar.
The username of the actor.
The HTTP path for this actor.
The HTTP URL for this actor.
Identifies the actor who triggered the deployment.
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.
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 deployment description.
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 latest environment to which this deployment was made.
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 Deployment object
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 latest environment to which this deployment was made.
DeploymentStatus [object]
Describes the status of a given deployment attempt.
Implements
Attributes
Identifies the date and time when the object was created.
Identifies the actor who triggered the deployment.
Identifies the deployment associated with status.
Identifies the description of the deployment.
Identifies the environment of the deployment at the time of this deployment status
Identifies the environment URL of the deployment.
The Node ID of the DeploymentStatus object
Identifies the log URL of the deployment.
Identifies the current state of the deployment.
Identifies the date and time when the object was last updated.
The latest status of this deployment.
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 original environment to which this deployment was made.
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.
Extra information that a deployment system might need.
Ref [object]
Represents a Git reference.
Implements
Attributes
A list of pull requests with this ref as the head ref.
Branch protection rules for this ref
Compares the current ref as a base ref to another head ref, if the comparison can be made.
The Node ID of the Ref object
The ref name.
The ref's prefix, such as refs/heads/ or refs/tags/.
Branch protection rules that are viewable by non-admins
The repository the ref belongs to.
A list of rules from active Repository and Organization rulesets that apply to this ref.
The object the ref points to. Returns null when object does not exist.
Identifies the Ref of the deployment, if the deployment was created by ref.
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.
Identifies the repository associated with the deployment.
DeploymentState [enum]
The possible states in which a deployment can be.
Possible values
The pending deployment was not updated after 30 minutes.
The deployment is currently active.
An inactive transient deployment.
The deployment experienced an error.
The deployment has failed.
The deployment is inactive.
The deployment is in progress.
The deployment is pending.
The deployment has queued
The deployment was successful.
The deployment is waiting.
The current state of the deployment.
DeploymentStatusConnection [object]
The connection type for DeploymentStatus.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
A list of statuses associated with the deployment.
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 deployment task.
Identifies the date and time when the object was last updated.