pull-request-review

👀 GitHub Action that reviews pull request code with AI and adds a PR comment.

Quick Start

# .github/workflows/pr-review.yml
on: pull_request
jobs:
  pr-review:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: PR review
        uses: ai-action/pull-request-review@v1

Usage

See action.yml:

- uses: ai-action/pull-request-review@v1

Inputs

model

Optional: The language model to use. Defaults to codellama:

- uses: ai-action/pull-request-review@v1
  with:
    model: codellama

prompt

Optional: The input prompt that comes before the PR diff. Defaults to:

- uses: ai-action/pull-request-review@v1
  with:
    prompt: 'Code review the diff:'

comment-header

Optional: The PR comment title in Markdown. Defaults to:

- uses: ai-action/pull-request-review@v1
  with:
    comment-header: '# Pull Request Review'

token

Optional: The GitHub token. Defaults to GITHUB_TOKEN:

- uses: ai-action/pull-request-review@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

License

MIT