Skip to main content

AI-powered PR descriptions, labels, and code review using OpenAI

Project description

pr-pilot ✈️

PyPI Downloads CI License: MIT

Stop writing PR descriptions. Let AI do it.

pr-pilot is a GitHub Action + CLI that analyzes your diff and commit history, then automatically writes a clear, structured PR description — with a summary, change list, test plan, and labels.

# .github/workflows/pr-description.yml
- uses: albertusreza/pr-pilot@main
  with:
    openai-api-key: ${{ secrets.OPENAI_API_KEY }}

That's it. Every new PR gets a description like this:


Add rate limiting to upload endpoint

Summary

Adds per-IP rate limiting to /api/upload using a sliding window algorithm. Without this, a single client could saturate the server with concurrent uploads.

Changes

  • Add RateLimiter middleware with configurable window and max requests
  • Apply limiter to /api/upload route (100 req/min default)
  • Return 429 Too Many Requests with Retry-After header
  • Add unit tests for edge cases (burst, reset, concurrent)

Test Plan

  1. Run pytest tests/test_rate_limiter.py
  2. Send 101 rapid requests to /api/upload — 101st should return 429
  3. Wait 60 seconds — requests should succeed again

Labels: feature, security


Install

As a GitHub Action (zero-config)

name: PR Pilot
on:
  pull_request:
    types: [opened, reopened]

jobs:
  describe:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      contents: read
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: albertusreza/pr-pilot@main
        with:
          openai-api-key: ${{ secrets.OPENAI_API_KEY }}

Add OPENAI_API_KEY to your repo secrets and you're done. Works with any language, any repo size.

As a CLI

pip install pullwise
export OPENAI_API_KEY=sk-...

# Generate a description for your current branch
pr-pilot describe

# Diff against a different base
pr-pilot describe --base develop

# Get a quick code review
pr-pilot review

# Save description as markdown
pr-pilot describe --markdown pr_description.md

Features

Command What it does
pr-pilot describe Generate a structured PR description from your diff
pr-pilot review Get a senior-engineer-style code review in the terminal
pr-pilot comment Post an AI review as a GitHub PR comment (updates on re-run, no spam)
pr-pilot changelog Generate a CHANGELOG.md entry from commits since last tag

Usage

# Generate PR description (terminal)
pr-pilot describe --base main

# Get a quick code review in the terminal
pr-pilot review --base main

# Post review as a GitHub PR comment
pr-pilot comment --repo owner/repo --pr 42

# Generate CHANGELOG entry (print to stdout)
pr-pilot changelog

# Write directly into CHANGELOG.md
pr-pilot changelog --output CHANGELOG.md

Auto-comment on every PR (GitHub Action)

# .github/workflows/pr-review.yml
- uses: actions/checkout@v4
  with:
    fetch-depth: 0
- run: pip install pullwise
- run: pr-pilot comment --repo ${{ github.repository }} --pr ${{ github.event.pull_request.number }}
  env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
    GITHUB_TOKEN: ${{ github.token }}

The comment updates itself on every new push — no duplicate comments.

Options

Input Default Description
openai-api-key Required. Your OpenAI API key
model gpt-4o OpenAI model to use
skip-labels false Skip adding labels to the PR
update-title false Also rewrite the PR title

How it works

  1. On PR open, checks out the branch with full history
  2. Runs git diff <base>...HEAD to get the full diff
  3. Collects commit messages with git log --oneline
  4. Sends both to GPT-4o with a structured prompt
  5. Parses the JSON response and updates the PR body + labels via GitHub API
  6. Skips update if the PR already has a substantial description (>100 chars)

Why

Over 60% of PRs are merged with descriptions like "fix bug", "WIP", or nothing at all. This makes code review harder, changelogs meaningless, and git history useless for future maintainers.

pr-pilot takes 30 seconds to set up and runs on every PR automatically — no discipline required.

Cost

Each PR description costs roughly $0.01–0.03 with gpt-4o depending on diff size. For a team of 5 opening ~20 PRs/week, that's about $1–3/month.

Self-hosted / private repos

Works with private repos. Just add the secret and the workflow file — no data leaves your GitHub Actions runner except the diff sent to OpenAI.

Contributing

git clone https://github.com/albertusreza/pr-pilot
cd pr-pilot
pip install -e ".[dev]"
pytest

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pullwise-0.2.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pullwise-0.2.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file pullwise-0.2.0.tar.gz.

File metadata

  • Download URL: pullwise-0.2.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for pullwise-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c20181fa761d96264991396ee56ae93cee9f8cb90bd98f6ab384492e76481e43
MD5 e7c4b3bf0544923fda7768d1b77c6224
BLAKE2b-256 3e63987409200d598144c13ffafb581004e535026915818f091789b35eeab0cc

See more details on using hashes here.

File details

Details for the file pullwise-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pullwise-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for pullwise-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f360b19265de90dfde4fa9915e83f9e5c58bf3174031dfd30beaf05944ace87
MD5 105f3478dcd894b466c11ab0e411b835
BLAKE2b-256 304eafab226bce339e6c680f686401c966b17a1bea1aea477306adacf12bf36a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page