Skip to main content


Home > @runlightyear/github > CreatePullRequestProps

CreatePullRequestProps interface

interface CreatePullRequestProps 

Required Properties

basestringThe 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.
headstringThe 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.
ownerstringThe account owner of the repository. The name is not case sensitive.
repostringThe name of the repository. The name is not case sensitive.

Optional Properties

body?stringThe contents of the pull request.
draft?booleanIndicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
issue?numberAn 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?booleanIndicates whether maintainers can modify the pull request.
title?stringThe title of the new pull request. Required unless issue is specified.