GitHub Action to automatically assign GitHub Copilot as a reviewer on pull requests.
- Automatically assigns GitHub Copilot as a reviewer using the correct bot username (
copilot-pull-request-reviewer[bot]) - Simple shell-based implementation using
gh apicommand - Better error handling with
ghCLI - Uses
GH_TOKENorGITHUB_TOKENfor authentication - No dependencies required (composite action,
ghCLI is pre-installed on GitHub Actions runners)
- Repository must have GitHub Copilot code review enabled
- Personal Access Token (PAT) with
pull_requests: writepermission is requiredGITHUB_TOKENmay not work in some cases due to permission limitations- It is recommended to use a PAT stored in repository secrets
Use a Personal Access Token (PAT) for reliable operation:
name: Assign Copilot Review
on:
pull_request:
types: [opened, synchronize, reopened]
jobs:
assign-copilot:
runs-on: ubuntu-latest
steps:
- name: Assign Copilot as reviewer
uses: mokmok-dev/assign-copilot-review-action@v1
with:
github-token: ${{ secrets.GH_TOKEN }}
pr-number: ${{ github.event.pull_request.number }}Note: Create a PAT with pull_requests: write permission and add it to your repository secrets as GH_TOKEN.
GITHUB_TOKEN may not work due to permission limitations:
name: Assign Copilot Review
on:
pull_request:
types: [opened, synchronize, reopened]
permissions:
pull-requests: write
jobs:
assign-copilot:
runs-on: ubuntu-latest
steps:
- name: Assign Copilot as reviewer
uses: mokmok-dev/assign-copilot-review-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
pr-number: ${{ github.event.pull_request.number }}You can specify a different repository:
- name: Assign Copilot as reviewer to another repo
uses: mokmok-dev/assign-copilot-review-action@v1
with:
github-token: ${{ secrets.GH_TOKEN }}
pr-number: 123
repository: owner/repoNote: The token must have pull_requests: write permission for the target repository.
| Input | Description | Required | Default |
|---|---|---|---|
github-token |
GitHub token with pull request write permissions | Yes | - |
pr-number |
Pull request number | Yes | - |
repository |
Repository in the format owner/repo | No | ${{ github.repository }} |
The action requires the following permissions:
permissions:
pull-requests: writeMIT
- ChrisCarini/gh-copilot-review - Inspiration for Copilot review automation
- mokmok-dev/delete-actions-cache - GitHub Actions implementation pattern reference