Magidoc

Commit
Object

Represents a Git commit.

Fields

#

abbreviatedOid

Non-null

An abbreviated version of the Git object ID

additions

Non-null

The number of additions in this commit.

associatedPullRequests

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

author

Authorship details of the commit.

authoredByCommitter

Non-null

Check if the committer and the author match.

authoredDate

Non-null

The datetime when this commit was authored.

authors

Non-null

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

Non-null

Fetches git blame information.

changedFiles

Non-null

We recommend using the changedFilesIfAvailable field instead of changedFiles , as changedFiles will cause your request to return an error if GitHub is unable to calculate the number of changed files.

changedFilesIfAvailable

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 return null . We recommend using this field instead of changedFiles .

checkSuites

The check suites associated with a commit.

comments

Non-null

Comments made on the commit.

commitResourcePath

Non-null

The HTTP path for this Git object

commitUrl

Non-null

The HTTP URL for this Git object

committedDate

Non-null

The datetime when this commit was committed.

committedViaWeb

Non-null

Check if committed via GitHub web UI.

committer

Committer details of the commit.

deletions

Non-null

The number of deletions in this commit.

deployments

The deployments associated with a commit.

file

The tree entry representing the file located at the given path.

history

Non-null

The linear commit history starting from (and including) this commit, in the same order as git log .

id

ID !
Non-null

The Node ID of the Commit object

message

Non-null

The Git commit message

messageBody

Non-null

The Git commit message body

messageBodyHTML

Non-null

The commit message body rendered to HTML.

messageHeadline

Non-null

The Git commit message headline

messageHeadlineHTML

Non-null

The commit message headline rendered to HTML.

oid

Non-null

The Git object ID

onBehalfOf

The organization this commit was made on behalf of.

parents

Non-null

The parents of a commit.

pushedDate

The datetime when this commit was pushed.

repository

Non-null

The Repository this commit belongs to

resourcePath

Non-null

The HTTP path for this commit

signature

Commit signing information, if present.

status

Status information for this commit

statusCheckRollup

Check and Status rollup information for this commit.

submodules

Non-null

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

tarballUrl

Non-null

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

Non-null

Commit's root Tree

treeResourcePath

Non-null

The HTTP path for the tree of this commit

treeUrl

Non-null

The HTTP URL for the tree of this commit

url

Non-null

The HTTP URL for this commit

viewerCanSubscribe

Non-null

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

viewerSubscription

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

zipballUrl

Non-null

Returns a URL to download a zipball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.

Interfaces

#

Also implements GitObject , Node , Subscribable , UniformResourceLocatable .

Usages

#

References

#