Create Pull Request
Create a pull request in GitHub.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
|
Organization |
Choose the organization that owns the repository where the pull request will be created. 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 where the pull request will be created. 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 |
|
Link to an Issue? |
Indicates whether to link the pull request to an issue. |
Dropdown |
TRUE |
|
From a Fork? |
Indicates whether you're working with forks and creating pull requests between them. If Yes, then the card adds the Fork Owner as an 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 |
|||
|
Issue Number |
Number of the issue that's associated with the new pull request. This field appears if you select Yes for the Link to an Issue option. |
Number |
FALSE |
|
BASE Branch |
The base branch of the new pull request. |
Text |
TRUE |
|
Fork Owner |
The owner of the fork where the new pull request is located. This field appears if you select Yes for the From a Fork? option. |
Text |
TRUE |
|
HEAD Branch |
Head branch of the new pull request. This field appears if you select Yes for the From a Fork? option. |
Text |
TRUE |
|
Is Draft? |
Set to True if the new pull request is a draft. |
True/False |
FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
Pull Request Number |
URL of the new pull request's URL. |
Text |
|
Pull Request ID |
ID of the new pull request. |
Number |
|
Pull Request Node ID |
Node ID of the new pull request. |
Text |
|
Title |
Title of the new pull request. |
Text |
|
State |
State of the new pull request. |
Text |
|
Description |
Description of the new pull request. |
Text |
|
Author Association |
Relationship of the author to the subject of the comment. |
Text |
|
Username |
Username of the user who raised the new pull request. |
Text |
|
User Node ID |
Node ID of the user. |
Text |
|
User ID |
Unique identifier of the user. |
Text |
|
Assignee Username |
Username of the user to whom the new pull request is assigned. |
Text |
|
Assignee Node ID |
Node ID of the assignee. |
Text |
|
Assignees |
Users to whom the new pull request is assigned. |
Object |
|
Labels |
List of labels associated with the new pull request. |
Object |
|
Milestone Title |
Title of the milestone associated with the new pull request. |
Text |
|
Milestone ID |
A unique identifier for the milestone with which the new pull request is associated. |
Text |
|
Milestone Node ID |
Node ID of the milestone with which the new pull request is associated. |
Text |
|
Milestone Number |
Milestone number milestone with which the new pull request is associated. |
Number |
|
Assignee ID |
Unique identifier of the assignee. |
Text |
|
BASE Branch |
The base branch of the new pull request. |
Text |
|
HEAD Branch |
The head branch of the new pull request. |
Text |
|
Diff URL |
A URL that contains a diff for the new pull request. |
Text |
|
HTML URL |
A URL that contains a human-readable HTML version of the new pull request. |
Text |
|
Patch URL |
A URL that contains a patch for the new pull request. |
Text |
|
Created At |
The time when the new pull request was created. |
Date & Time |
|
Updated At |
The time when the new pull request was last updated. |
Date & Time |
|
Maintainer Can Modify? |
If True, the upstream maintainers can modify the new pull request. |
True/False |
|
Is Locked? |
If True, the new pull request is locked. |
True/False |
|
Is Draft? |
If True, the new pull request is a draft. |
True/False |
|
Additions Count |
The number of additions included in the new pull request. |
Number |
|
Deletions Count |
The number of deletions included in the new pull request. |
Number |
|
Changed Files Count |
The number of files changed by the new pull request. |
Number |
|
Commits Count |
The number of commits included in the new pull request. |
Number |