README.md

pull-request-summary

📝 GitHub Action that summarizes pull requests with AI (LLM).

Quick Start

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

Usage

Append summary to PR description:

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

See action.yml

Inputs

model

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

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

prompt

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

- uses: ai-action/pull-request-summary@v1
  with:
    prompt: 'Summarize the code diff concisely:'

token

Optional: The GitHub token. Defaults to GITHUB_TOKEN:

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

License

MIT