Read Pull Request
Read a pull request from GitHub.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
|
Organization |
Choose the organization that owns the repository containing the pull request. The dropdown list displays the organizations for the authenticated user. The list is limited to 100 organizations. If the repository is under a personal account, select the -- Not In Org -- option. |
Dropdown |
TRUE |
|
Repository |
Choose the repository that contains the pull request. The dropdown list displays the repositories for the selected Organization. If you select the -- Input Repo Full Name -- option, then the card ignores the Organization selection and you must enter the full name of the repository in the Repository input field. |
Dropdown |
TRUE |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Repository |
|||
|
Full Name |
The full name of the repository. This input field appears when you select -- Input Repo Full Name -- as the Repository option. The name must be formatted as <org_name>/<repo_name> if the repository is within an organization, or <owner_name>/<repo_name> if the repository is under a personal account. The card returns an error if the repository doesn't exist or the user doesn't have permission to access the repository. |
Text |
TRUE |
|
Pull Request Number |
The number of the pull request to read. |
Text |
FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
State |
State of the pull request. |
Text |
|
Title |
Title of the pull request. |
Text |
|
Description |
Description of the pull request. |
Text |
|
Author Association |
Relationship of the author to the subject of the comment. |
Text |
|
Username |
Username of the user who raised the pull request. |
Text |
|
User Node ID |
Node ID of the user. |
Text |
|
User ID |
Unique identifier of the user. |
Number |
|
Assignee Username |
Username of the user to whom the pull request is assigned. |
Text |
|
Assignee Node ID |
Node ID of the assignee. |
Text |
|
Merged By |
The ID of the user to whom the pull request is assigned. |
Text |
|
Assignees |
Users to whom the pull request is assigned. |
List of Objects |
|
Requested Reviewers |
Users who were requested to review the pull request. |
List of Objects |
|
Requested Teams |
Teams who were requested to review the pull request. |
List of Objects |
|
Labels |
List of labels associated with the pull request. |
List of Objects |
|
Is Mergeable? |
If True, the pull request can be merged. If null, then GitHub is determining if the pull can be merged. |
True/False |
|
Mergeable State |
Current state of the merge. There are three possible states: clean, dirty, or unstable. |
Text |
|
Pull Request ID |
ID of the pull request. |
Number |
|
Pull Request Node ID |
Node ID of the pull request. |
Text |
|
Pull Request Number |
The pull request's URL. |
Text |
|
Milestone Title |
Title of the milestone associated with the pull request. |
Text |
|
Milestone ID |
A unique identifier for the milestone with which the pull request is associated. |
Number |
|
Merge Commit SHA |
State of the milestone. |
Text |
|
Milestone Number |
Milestone number milestone with which the pull request is associated. |
Number |
|
Assignee ID |
The ID of the user to whom the pull request is assigned. |
Number |
|
Active Lock Reason |
Reason for a lock, if any. |
Text |
|
BASE Branch |
Base branch of the pull request. |
Text |
|
HEAD Branch |
Head branch of the pull request. |
Text |
|
Diff URL |
A URL that contains a diff for the pull request. |
Text |
|
HTML URL |
A URL that contains a human-readable HTML version of the pull request. |
Text |
|
Patch URL |
A URL that contains a patch for the pull request. |
Text |
|
Created At |
The time when the pull request was created. |
Date & Time |
|
Merged At |
The time when the pull request was merged. |
Date & Time |
|
Closed At |
The time when the pull request was closed. |
Date & Time |
|
Updated At |
The time when the pull request was last updated. |
Date & Time |
|
Is Merged? |
If True, the pull request has been merged. |
True/False |
|
Maintainer Can Modify? |
If True, the upstream maintainers can modify the pull request. |
True/False |
|
Is Locked? |
If True, the pull request is locked. |
True/False |
|
Is Draft? |
If True, the pull request is a draft. |
True/False |
|
Additions Count |
Number of additions included in the pull request. |
Number |
|
Review Comments Count |
Number of review comments included in the pull request. |
Number |
|
Comments Count |
Number of comments included in the pull request. |
Number |
|
Deletions Count |
Number of deletions included in the pull request. |
Number |
|
Changed Files Count |
Number of files changed by the pull request. |
Number |
|
Commits Count |
Number of commits included in the pull request. |
Number |