Skip to content

README.md

Latest commit

 

History

History
48 lines (37 loc) · 1.68 KB

README.md

File metadata and controls

48 lines (37 loc) · 1.68 KB
Raw

Approve PR

Approve a pull request using a GitHub App identity. This is needed because GITHUB_TOKEN cannot provide independent approvals that satisfy branch protection rules requiring multiple reviewers.

Inputs

Name Description Required Default
client-id GitHub App Client ID (preferred over the deprecated app-id) ❌¹ -
app-id GitHub App ID. Deprecated — use client-id instead ❌¹ -
app-private-key GitHub App Private Key ✅ unless dry-run is true -
pr-number Pull request number to approve ✅ -
dry-run Validate only; do not approve the pull request - false

¹ Provide exactly one of client-id or app-id. Prefer client-id: actions/create-github-app-token has deprecated app-id, so passing it emits a Input 'app-id' has been deprecated warning.

Dry-run mode needs no GitHub App credentials and performs no mutation.

Usage

Approve a PR from a trusted bot

steps:
  - name: Approve PR
    uses: devantler-tech/actions/approve-pr@main
    with:
      client-id: ${{ vars.APP_CLIENT_ID }}
      app-private-key: ${{ secrets.APP_PRIVATE_KEY }}
      pr-number: ${{ github.event.pull_request.number }}

Combined with auto-merge

steps:
  - name: Approve PR
    uses: devantler-tech/actions/approve-pr@main
    with:
      client-id: ${{ vars.APP_CLIENT_ID }}
      app-private-key: ${{ secrets.APP_PRIVATE_KEY }}
      pr-number: ${{ github.event.pull_request.number }}

  - name: Enable auto-merge
    uses: devantler-tech/actions/enable-auto-merge-on-pr@main
    with:
      pr-number: ${{ github.event.pull_request.number }}