Skip to content

README.md

Latest commit

 

History

History
66 lines (52 loc) · 3.38 KB

README.md

File metadata and controls

66 lines (52 loc) · 3.38 KB

Create pull request action

This action creates a pull request from a branch to a target branch.

Any pull requests created as a result of actions that use the default token (${{ GITHUB_TOKEN }}) will not trigger any pipeline events. To ensure that any pipelines are triggered, a different token must be used.

Any files that will be changed and committed to the pull request must be listed in the .github/repo_policies/BOT_APPROVED_FILES file of the repository. For example:

CHANGELOG.md
Cargo.toml
packages/some-package/package.json

Action inputs

Input Description Default
branch_name The name of the branch to create the pull request from. 'patch'
base_branch_name The name of the base branch to create a pull request against. 'main'
pull_request_title The title of the pull request. 'chore: automated by GitHub actions'
pull_request_body The body of the pull request. 'This pull request was automatically created by a GitHub Action.'
author_name The name of the author of the pull request and commit. ${{ github.actor }}
author_email The email of the author of the pull request and commit. ${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com
commit_message The message of the commit. 'chore: automated by GitHub actions'
token Access token to manage the pull request. ${{ GITHUB_TOKEN }}

Action outputs

  • pull_request_number: The number of the created pull request.
  • pull_request_created: A boolean indicating whether the pull request was created. This will be false is there are no changes to commit.

Example usage

name: Create pull request

on:
  push:
    branches:
      - main

jobs:
  create_pr:
    runs-on: ubuntu-latest
    steps:
      - name: Create GitHub App Token
        uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
        id: generate_token
        with:
          app-id: ${{ vars.PR_AUTOMATION_BOT_PUBLIC_APP_ID }}
          private-key: ${{ secrets.PR_AUTOMATION_BOT_PUBLIC_PRIVATE_KEY }}

      - name: Checkout repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Create pull request
        uses: dfinity/ci-tools/actions/create-pr@main
        with:
          branch_name: 'chore/generate-changelog'
          base_branch_name: 'main'
          pull_request_title: 'chore: generate changelog'
          pull_request_body: 'This pull request was automatically created by a GitHub Action to generate changelogs.'
          commit_message: 'chore: generate changelog'
          token: ${{ steps.generate_token.outputs.token }}