github.createpullrequestprops
Home > @runlightyear/github > CreatePullRequestProps
CreatePullRequestProps interface
Signature:interface CreatePullRequestProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| base | string | The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. | |
| head | string | The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch. | |
| owner | string | The account owner of the repository. The name is not case sensitive. | |
| repo | string | The name of the repository. The name is not case sensitive. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| body? | string | The contents of the pull request. | |
| draft? | boolean | Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more. | |
| issue? | number | An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified. | |
| maintainerCanModify? | boolean | Indicates whether maintainers can modify the pull request. | |
| title? | string | The title of the new pull request. Required unless issue is specified. |