PullRequestCommits
Provides a list of commits included in pull requests, detailing the changes introduced and the commits' authors.
View-Specific Information
Select
The add-in uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
- PullRequestNumber supports the '=,IN' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestCommits]
SELECT * FROM [PullRequestCommits] WHERE [PullRequestNumber] = 123
The add-in processes other filters client-side within the add-in.
Columns
| Name | Type | References | OrderBySupport | Description |
| Id | String | Represents the unique identifier for the commit, which can be used to reference or track the commit within the GitHub repository. | ||
| Oid | String | Represents the Git object ID, a globally unique identifier for the commit in the Git repository, used for identifying commits in Git operations. | ||
| AbbreviatedOid | String | A shortened version of the Git object ID, used for easier display and reference in user interfaces where a full ID is not necessary. | ||
| ChangedFilesIfAvailable | Int | Represents the number of files changed in this commit. If the number cannot be determined (for example, due to timeouts), the field returns 'null'. It is the preferred field to use over 'changedFiles'. | ||
| Additions | Int | Indicates the number of lines added in this commit. This provides insight into the extent of code changes made. | ||
| Deletions | Int | Indicates the number of lines deleted in this commit. This gives an idea of how much code was removed in the commit. | ||
| AuthoredByCommitter | Bool | Indicates whether the author of the commit is the same as the committer. If 'true', the author and the committer are the same person. | ||
| CommittedViaWeb | Bool | Indicates whether the commit was made through GitHub’s web interface, rather than through a Git client. | ||
| AuthoredDate | Datetime | Represents the date and time when the commit was authored, based on the author’s local machine settings at the time of creation. | ||
| CommittedDate | Datetime | Represents the date and time when the commit was actually committed, based on the commit timestamp recorded by the Git system. | ||
| ViewerSubscription | String | Indicates the viewer's current subscription status for the entity, such as 'WATCHING', 'NOT WATCHING', or 'IGNORING'. This allows for tracking user interest. | ||
| ViewerCanSubscribe | Bool | Indicates whether the viewer can change their subscription status for the repository, allowing the viewer to adjust their notifications preferences. | ||
| Message | String | Contains the full commit message associated with the commit, which might include both the headline and the detailed description of the changes. | ||
| MessageBody | String | The body of the commit message, providing a detailed explanation of the changes made in the commit to help reviewers understand the modifications. | ||
| MessageHeadline | String | The headline or summary line of the commit message, usually a brief overview of the commit’s purpose or changes. | ||
| MessageBodyHTML | String | The body of the commit message rendered as HTML, which allows the message to be displayed with any HTML formatting applied. | ||
| MessageHeadlineHTML | String | The headline of the commit message rendered as HTML, providing a visually formatted summary of the commit changes. | ||
| ResourcePath | String | Specifies the relative HTTP path to access this commit via the GitHub API, enabling programmatic access to the commit details. | ||
| CommitResourcePath | String | Specifies the relative HTTP path for this Git object within the GitHub API, allowing access to detailed information about the specific commit object. | ||
| TreeResourcePath | String | Specifies the relative HTTP path to access the commit tree via the GitHub API. The tree represents the file structure as it was at the commit. | ||
| Url | String | Provides the full HTTP URL to access this commit directly on GitHub, allowing users to view the commit’s details in a browser. | ||
| CommitUrl | String | Provides the full HTTP URL for the specific Git object associated with the commit, enabling access to detailed information about the commit in the repository. | ||
| TarballUrl | String | The URL to download a tarball archive of the repository at the commit's state. For private repositories, the URL expires within five minutes. | ||
| TreeUrl | String | The full HTTP URL for accessing the tree structure of this commit, providing a way to view the file hierarchy of the commit’s changes. | ||
| ZipballUrl | String | The URL to download a zipball archive of the repository at the commit's state. This link is temporary and expires within five minutes for private repositories. | ||
| AuthorName | String | The name of the author as listed in the Git commit, identifying the individual who wrote the changes in the commit. | ||
| AuthorEmail | String | The email address of the commit author, which can be used for contact or identification purposes. | ||
| AuthorDate | Datetime | Represents the timestamp when the commit was authored, according to the author’s local machine settings and recorded in the commit. | ||
| AuthorUserLogin | String | The GitHub username associated with the author's email, or 'null' if no corresponding user is found on GitHub. | ||
| CommitterName | String | The name of the individual or bot who made the commit, as recorded in the Git commit metadata. | ||
| CommitterEmail | String | The email address associated with the committer, which is recorded in the Git commit metadata. | ||
| CommitterDate | Datetime | The date and time when the commit was created, representing when the commit was authored or committed, depending on the scenario. | ||
| CommitterUserLogin | String | The GitHub username linked to the committer's email address. If no matching user is found, the value is 'null'. | ||
| OnBehalfOfId | String | A unique identifier for the organization on whose behalf the commit was made, if applicable. | ||
| OnBehalfOf | String | The login name of the GitHub organization that is associated with the commit, if the commit was made on behalf of an organization. | ||
| SignatureIsValid | Bool | Indicates whether the commit's GPG signature is valid and verified by GitHub. A 'true' value means the signature is verified. | ||
| Signature | String | The ASCII-armored GPG signature associated with the commit, which is used to verify the commit's authenticity. | ||
| SignatureEmail | String | The email address used in the GPG signature, typically associated with the person or bot who signed the commit. | ||
| SignaturePayload | String | The raw data of the commit (without the GPG signature header) that was signed using GPG encryption. | ||
| SignatureState | String | The state of the GPG signature, such as 'VALID' if it has been successfully verified, or other values indicating why the signature failed verification. | ||
| SignatureSigner | String | The GitHub username of the individual or bot that signed the commit, matching the email used for signing. | ||
| WasSignedByGitHub | Bool | Indicates whether the commit was signed using GitHub's own GPG key, marking it as a trusted commit. | ||
| StatusId | String | A unique identifier for the status of the commit, which can be linked to external status checks such as continuous integration results. | ||
| StatusState | String | The combined status of the commit reflecting the success or failure of the commit as determined by status checks (for example, 'SUCCESS', 'ERROR'). | ||
| StatusCheckRollupId | String | A unique identifier for the aggregated status checks and results that apply to the commit. | ||
| StatusCheckRollupState | String | The overall result of the combined status checks and any additional validations, such as 'SUCCESS', 'FAILURE', etc. | ||
| TreeId | String | The unique identifier for the root tree object that represents the snapshot of the directory structure at the time of the commit. | ||
| TreeOid | String | The Git object ID representing the tree associated with the commit, which is a key part of the commit's internal structure. | ||
| TreeAbbreviatedOid | String | A shortened version of the full Git object ID for the tree associated with the commit, for easier reference. | ||
| TreeCommitUrl | String | The full URL for accessing the commit's tree object on GitHub, allowing access to the directory structure at that commit. | ||
| TreeCommitResourcePath | String | The relative path within the GitHub API to access the tree object, used for programmatic access to the commit's directory structure. | ||
| PullRequestCommitId [KEY] | String | A unique node ID identifying the specific commit within the context of the pull request, used for referencing this commit in the pull request. | ||
| PullRequestCommitResourcePath | String | The relative path within the GitHub API for accessing the specific pull request commit, which is part of the pull request's commit history. | ||
| PullRequestCommitUrl | String | The full URL to view the specific pull request commit directly on GitHub, allowing quick access to the commit's page in the pull request. | ||
| PullRequestId | String | A unique identifier for the pull request associated with this commit, used to link the commit to the specific pull request in GitHub. | ||
| PullRequestNumber | Int | The number assigned to the pull request for identification within the repository, used to track and reference the pull request. |