The Create Pull Request action creates a new pull request in a GitHub repository.

Overview

The Create Pull Request action creates a new pull request in a GitHub repository using the source and target branch names. After pull request creation, the action returns the pull request number as the response data. The action requires an active GitHub session to authenticate the request.

Settings

The Create Pull Request action contains the following settings:

Note: All the input fields support string variables. You can create a string variable to hold the appropriate text string and select it in the applicable setting and option.
Session name

Specifies the GitHub session name that the Connect action creates. Use one of the following options to specify the session name:

  • Session name: Enter the session name as text directly or select the string variable that holds the session name text.
  • Variable: Select the GitHub session variable that the Connect action creates.
Owner name
Specifies the name of the GitHub repository owner. The owner can be an organization or a user account. You can either enter the name directly as text or select the applicable string variable.
Repository name
Specifies the name of the GitHub repository in which the action creates the pull request. You can either enter the repository name directly as text or select the applicable string variable.
Title
Specifies the title of the pull request. You can either enter the title directly as text or select the applicable string variable.
Description (optional)
Specifies the description of the pull request. You can either enter the description directly as text or select the applicable string variable.
Source branch name
Specifies the name of the branch that contains the changes to merge. You can either enter the branch name directly as text or select the applicable string variable.
Target branch name
Specifies the name of the branch into which the changes must be merged. You can either enter the branch name directly as text or select the applicable string variable.
Assign output to variable
Specifies the string variable in which the action stores the pull request number.