Releases: peter-evans/create-pull-request
Create Pull Request v3.4.0
- Adds the action output
pull-request-url
, the URL of the created or updated pull request.
Create Pull Request v3.3.0
- Fixes a bug that occurred when squash merging pull requests and leaving the branch undeleted
- Adds a
delete-branch
input. Whentrue
the action deletes thebranch
when closing pull requests, and when undeleted after merging.
Create Pull Request v3.2.0
- Adds support for workflow events that checkout a commit and leave repositories in a "detached HEAD" state. The action can now handle this situation provided it is supplied with the
base
input. See events which checkout a commit.
Create Pull Request v3.1.2
- Fixes a bug where the action would fail to create a pull request for branches that are already up to date. This condition can occur when closing a pull request and not deleting the branch.
Create Pull Request v3.1.1
- Fixes a minor issue when using
push-to-fork
. It's now possible for the fork'sbranch
to be the same name as the parent'sbase
.
Create Pull Request v3.1.0
- Adds input
signoff
which when set totrue
will add aSigned-off-by
line by the committer at the end of the commit log message. This allows created pull requests to meet requirements set by some projects for commits to adhere to the Developers Certificate of Origin (DCO).
Create Pull Request v3.0.0
Breaking changes
-
The
author
input now defaults to the user who triggered the workflow run. This default is set via action.yml as${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
, wheregithub.actor
is the GitHub user account associated with the run. For example,peter-evans <peter-evans@users.noreply.github.com>
.To continue to use the
v2
default, set theauthor
input as follows.- uses: peter-evans/create-pull-request@v3 with: author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-
The
author
andcommitter
inputs are no longer cross-used if only one is supplied. Additionally, when neither input is set, theauthor
andcommitter
are no longer determined from an existing identity set in git config. In both cases, the inputs will fall back to their default set in action.yml. -
Deprecated inputs
project
andproject-column
have been removed in favour of an additional action step. See Create a project card for details. -
Deprecated output
pr_number
has been removed in favour ofpull-request-number
. -
Input
request-to-parent
has been removed in favour ofpush-to-fork
. This greatly simplifies pushing the pull request branch to a fork of the parent repository. See Push pull request branches to a fork for details.e.g.
- uses: actions/checkout@v2 # Make changes to pull request here - uses: peter-evans/create-pull-request@v3 with: token: ${{ secrets.MACHINE_USER_PAT }} push-to-fork: machine-user/fork-of-repository
New features
-
The action has been converted to Typescript giving it a significant performance improvement.
-
If you run this action in a container, or on self-hosted runners,
python
andpip
are no longer required dependencies. See Running in a container or on self-hosted runners for details. -
Inputs
labels
,assignees
,reviewers
andteam-reviewers
can now be newline separated, or comma separated.
e.g.labels: | chore dependencies automated
Create Pull Request v2.8.1
- Minor fix to correctly parse repository URLs with embedded credentials
Create Pull Request v2.8.0
- Converted Javascript action wrapper to Typescript
Create Pull Request v2.7.3
- Fixes a missing definition for input
draft
that caused a warning annotation