Commit [object]
Represents a Git commit.
Implements
GitObject [interface]
Represents a Git object.
Attributes
An abbreviated version of the Git object ID
The HTTP path for this Git object
The HTTP URL for this Git object
The Node ID of the GitObject object
The Git object ID
The Repository the Git object belongs to
Subscribable [interface]
Entities that can be subscribed to for web and email notifications.
Attributes
The Node ID of the Subscribable object
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.
Attributes
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.
An abbreviated version of the Git object ID
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
The number of additions in this commit.
PullRequestConnection [object]
The connection type for PullRequest.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
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
GitActor [object]
Represents an actor in a Git commit (ie. an author or committer).
Attributes
A URL pointing to the author's public avatar.
The timestamp of the Git action (authoring or committing).
The email in the Git commit.
The name in the Git commit.
The GitHub user corresponding to the email field. Null if no such user exists.
Authorship details of the commit.
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if the committer and the author match.
The datetime when this commit was authored.
GitActorConnection [object]
The connection type for GitActor.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
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.
Blame [object]
Represents a Git blame.
Attributes
The list of ranges from a Git blame.
Fetches git blame information.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
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.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
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.
CheckSuiteConnection [object]
The connection type for CheckSuite.
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 suites associated with a commit.
CommitCommentConnection [object]
The connection type for CommitComment.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
Comments made on the commit.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for this Git object
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for this Git object
DateTime [scalar]
An ISO-8601 encoded UTC date string.
The datetime when this commit was committed.
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if committed via GitHub web UI.
GitActor [object]
Represents an actor in a Git commit (ie. an author or committer).
Attributes
A URL pointing to the author's public avatar.
The timestamp of the Git action (authoring or committing).
The email in the Git commit.
The name in the Git commit.
The GitHub user corresponding to the email field. Null if no such user exists.
Committer details of the commit.
Int [scalar]
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
The number of deletions in this commit.
DeploymentConnection [object]
The connection type for Deployment.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The deployments associated with a commit.
TreeEntry [object]
Represents a Git tree entry.
Attributes
The extension of the file
Whether or not this tree entry is generated
The programming language this file is written in.
Number of lines in the file.
Entry file mode.
Entry file name.
Entry file name. (Base64-encoded)
Entry file object.
Entry file Git object ID.
The full path of the file.
The full path of the file. (Base64-encoded)
The Repository the tree entry belongs to
Entry byte size
If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule
Entry file type.
The tree entry representing the file located at the given path.
CommitHistoryConnection [object]
The connection type for Commit.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The linear commit history starting from (and including) this commit, in the same order as git log.
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 Commit 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 Git commit message
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 Git commit message body
The commit message body rendered to HTML.
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 Git commit message headline
The commit message headline rendered to HTML.
The Git object ID
Organization [object]
An account on GitHub, with one or more owners, that has repositories, members and teams.
Implements
Attributes
The text of the announcement
The expiration date of the announcement, if any
Whether the announcement can be dismissed by the user
Determine if this repository owner has any items that can be pinned to their profile.
Identifies the date and time when the organization was archived.
Audit log entries of the organization
A URL pointing to the organization's public avatar.
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The organization's public profile description.
The organization's public profile description rendered to HTML.
A list of domains owned by the organization.
The organization's public email.
A list of owners of the organization's enterprise account.
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
True if this user/organization has a GitHub Sponsors listing.
The Node ID of the Organization object
The interaction ability settings for this organization.
The setting value for whether the organization has an IP allow list enabled.
The IP addresses that are allowed to access resources owned by the organization.
The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled.
Whether the given account is sponsoring this user/organization.
True if the viewer is sponsored by this user/organization.
Whether the organization has verified its profile email and website.
Showcases a selection of repositories and gists that the profile owner has
either curated or that have been selected automatically based on popularity.
Calculate how much each sponsor has ever paid total to this maintainer via
GitHub Sponsors. Does not include sponsorships paid via Patreon.
The organization's public profile location.
The organization's login name.
A list of all mannequins for this organization.
Get the status messages members of this entity have set that are either public or visible only to the organization.
Members can fork private repositories in this organization
A list of users who are members of this organization.
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
The organization's public profile name.
The HTTP path creating a new team
The HTTP URL creating a new team
Indicates if email notification delivery for this organization is restricted to verified or approved domains.
The billing email for the organization.
A list of packages under the owner.
A list of users who have been invited to join this organization.
A list of repositories and gists this profile owner can pin to their profile.
A list of repositories and gists this profile owner has pinned to their profile
Returns how many more items this profile owner can pin to their profile.
Find project by number.
Find a project by number.
A list of projects under the owner.
The HTTP path listing organization's projects
The HTTP URL listing organization's projects
A list of projects under the owner.
Recent projects that this user has modified in the context of the owner.
A list of repositories that the user owns.
Find Repository.
Discussion comments this user has authored.
Discussions this user has started.
A list of all repository migrations for this organization.
When true the organization requires all members, billing managers, and outside
collaborators to enable two-factor authentication.
The HTTP path for this organization.
Returns a single ruleset from the current organization by ID.
A list of rulesets for this organization.
The Organization's SAML identity provider. Visible to (1) organization owners,
(2) organization owners' personal access tokens (classic) with read:org or
admin:org scope, (3) GitHub App with an installation token with read or write
access to members.
List of users and organizations this entity is sponsoring.
List of sponsors for this user or organization.
Events involving this sponsorable, such as new sponsorships.
The GitHub Sponsors listing for this user or organization.
The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.
The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.
List of sponsorship updates sent from this sponsorable to sponsors.
The sponsorships where this user or organization is the maintainer receiving the funds.
The sponsorships where this user or organization is the funder.
Find an organization's team by its slug.
A list of teams in this organization.
The HTTP path listing organization's teams
The HTTP URL listing organization's teams
The amount in United States cents (e.g., 500 = $5.00 USD) that this entity has
spent on GitHub to fund sponsorships. Only returns a value when viewed by the
user themselves or by a user who can manage sponsorships for the requested organization.
The organization's Twitter username.
Identifies the date and time when the object was last updated.
The HTTP URL for this organization.
Organization is adminable by the viewer.
Can the viewer pin repositories and gists to the profile?
Can the current viewer create new projects on this owner.
Viewer can create repositories on this organization
Viewer can create teams on this organization.
Whether or not the viewer is able to sponsor this user/organization.
Viewer is an active member of this organization.
Whether or not this Organization is followed by the viewer.
True if the viewer is sponsoring this user/organization.
Whether contributors are required to sign off on web-based commits for repositories in this organization.
The organization's public profile URL.
The organization this commit was made on behalf of.
CommitConnection [object]
The connection type for Commit.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The parents of a commit.
The datetime when this commit was pushed.
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 this commit belongs to
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for this commit
GitSignature [interface]
Information about a signature (GPG or S/MIME) on a Commit or Tag.
Attributes
Email used to sign this object.
True if the signature is valid and verified by GitHub.
Payload for GPG signing object. Raw ODB object without the signature header.
ASCII-armored signature header from object.
GitHub user corresponding to the email signing this commit.
The state of this signature. VALID if signature is valid and verified by
GitHub, otherwise represents reason why signature is considered invalid.
True if the signature was made with GitHub's signing key.
Commit signing information, if present.
Status [object]
Represents a commit status.
Implements
Attributes
A list of status contexts and check runs for this commit.
The commit this status is attached to.
Looks up an individual status context by context name.
The individual status contexts for this commit.
The Node ID of the Status object
The combined commit status.
Status information for this commit
StatusCheckRollup [object]
Represents the rollup for both the check runs and status for a commit.
Implements
Attributes
The commit the status and check runs are attached to.
A list of status contexts and check runs for this commit.
The Node ID of the StatusCheckRollup object
The combined status for the commit.
Check and Status rollup information for this commit.
SubmoduleConnection [object]
The connection type for Submodule.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
Tree [object]
Represents a Git tree.
Implements
Attributes
An abbreviated version of the Git object ID
The HTTP path for this Git object
The HTTP URL for this Git object
A list of tree entries.
The Node ID of the Tree object
The Git object ID
The Repository the Git object belongs to
Commit's root Tree
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for the tree of this commit
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for the tree of this commit
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for this commit
Boolean [scalar]
The Boolean scalar type represents true or false.
Check if the viewer is able to change their subscription status for the repository.
SubscriptionState [enum]
The possible states of a subscription.
Possible values
The User is never notified.
The User is notified of all conversations.
The User is only notified when participating or @mentioned.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.