Skip to content

Create Pull Request v3.0.0

Compare
Choose a tag to compare
@peter-evans peter-evans released this 23 Jul 06:26
ebc5e02

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>, where github.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 the author 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 and committer inputs are no longer cross-used if only one is supplied. Additionally, when neither input is set, the author and committer 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 and project-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 of pull-request-number.

  • Input request-to-parent has been removed in favour of push-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 and pip are no longer required dependencies. See Running in a container or on self-hosted runners for details.

  • Inputs labels, assignees, reviewers and team-reviewers can now be newline separated, or comma separated.
    e.g.

            labels: |
              chore
              dependencies
              automated