MergeQueueEntry [object]
Entries in a MergeQueue
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.
The base commit for this entry
The date and time this entry was added to the merge queue
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.
The actor that enqueued this entry
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 estimated time in seconds until this entry will be merged
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.
The head commit for this entry
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 MergeQueueEntry object
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether this pull request should jump the queue
MergeQueue [object]
The queue of pull request entries to be merged into a protected branch in a repository.
Implements
Attributes
The configuration for this merge queue
The entries in the queue
The Node ID of the MergeQueue object
The estimated time in seconds until a newly added entry would be merged
The repository this merge queue belongs to
The HTTP path for this merge queue
The HTTP URL for this merge queue
The merge queue that this entry belongs to
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 position of this entry in the queue
PullRequest [object]
A repository pull request.
Implements
Attributes
Reason that the conversation was locked.
The number of additions in this pull request.
A list of Users assigned to this object.
The actor who authored the comment.
Author's association with the subject of the comment.
Returns the auto-merge request object if one exists for this pull request.
Identifies the base Ref associated with the pull request.
Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
The repository associated with this pull request's base Ref.
The body as Markdown.
The body rendered to HTML.
The body rendered to text.
Whether or not the pull request is rebaseable.
The number of changed files in this pull request.
The HTTP path for the checks of this pull request.
The HTTP URL for the checks of this pull request.
true
if the pull request is closed
Identifies the date and time when the object was closed.
List of issues that were may be closed by this pull request
A list of comments associated with the pull request.
A list of commits present in this pull request's head branch not present in the base branch.
Identifies the date and time when the object was created.
Check if this comment was created via an email reply.
Identifies the primary key from the database.
The number of deletions in this pull request.
The actor who edited this pull request's body.
Lists the files changed within this pull request.
Identifies the primary key from the database as a BigInt.
Identifies the head Ref associated with the pull request.
Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.
The repository associated with this pull request's head Ref.
The owner of the repository associated with this pull request's head Ref.
The hovercard information for this issue
The Node ID of the PullRequest object
Check if this comment was edited and includes an edit with the creation data
The head and base repositories are different.
Identifies if the pull request is a draft.
Indicates whether the pull request is in a merge queue
Indicates whether the pull request's base ref has a merge queue enabled.
Is this pull request read by the viewer
A list of labels associated with the object.
The moment the editor made the last edit
A list of latest reviews per user associated with the pull request.
A list of latest reviews per user associated with the pull request that are not also pending review.
true
if the pull request is locked
Indicates whether maintainers can modify the pull request.
The commit that was created when this pull request was merged.
The merge queue for the pull request's base branch
The merge queue entry of the pull request in the base branch's merge queue
Detailed information about the current pull request merge state status.
Whether or not the pull request can be merged based on the existence of merge conflicts.
Whether or not the pull request was merged.
The date and time that the pull request was merged.
The actor who merged the pull request.
Identifies the milestone associated with the pull request.
Identifies the pull request number.
A list of Users that are participating in the Pull Request conversation.
The permalink to the pull request.
The commit that GitHub automatically generated to test if this pull request
could be merged. This field will not return a value if the pull request is
merged, or if the test merge commit is still being generated. See themergeable
field for more details on the mergeability of the pull request.
List of project cards associated with this pull request.
List of project items associated with this pull request.
Find a project by number.
A list of projects under the owner.
Identifies when the comment was published at.
A list of reactions grouped by content left on the subject.
A list of Reactions left on the Issue.
The repository associated with this node.
The HTTP path for this pull request.
The HTTP path for reverting this pull request.
The HTTP URL for reverting this pull request.
The current status of this pull request with respect to code review.
A list of review requests associated with the pull request.
The list of all review threads for this pull request.
A list of reviews associated with the pull request.
Identifies the state of the pull request.
A list of reviewer suggestions based on commit history and past review comments.
A list of events, comments, commits, etc. associated with the pull request.
A list of events, comments, commits, etc. associated with the pull request.
Identifies the pull request title.
Identifies the pull request title rendered to HTML.
Returns a count of how many comments this pull request has received.
Identifies the date and time when the object was last updated.
The HTTP URL for this pull request.
A list of edits to this content.
Whether or not the viewer can apply suggestion.
Indicates if the object can be closed by the viewer.
Check if the viewer can restore the deleted head ref.
Whether or not the viewer can disable auto-merge
Can the viewer edit files within this pull request.
Whether or not the viewer can enable auto-merge
Indicates whether the viewer can bypass branch protections and merge the pull request immediately
Can user react to this subject
Indicates if the object can be reopened by the viewer.
Check if the viewer is able to change their subscription status for the repository.
Check if the current viewer can update this object.
Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref.
If the head ref is up to date or unable to be updated by this user, this will return false.
Reasons why the current viewer can not update this comment.
Did the viewer author this comment.
The latest review given from the viewer.
The person who has requested the viewer for review on this pull request.
The merge body text for the viewer and method.
The merge headline text for the viewer and method.
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
The pull request that will be added to a merge group
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Does this pull request need to be deployed on its own
MergeQueueEntryState [enum]
The possible states for a merge queue entry.
Possible values
The entry is currently waiting for checks to pass.
The entry is currently locked.
The entry is currently mergeable.
The entry is currently queued.
The entry is currently unmergeable.
The state of this entry in the queue