pulls.review README

The project's README from github.com/antfu/pulls.review. As one markdown file: README.md.

pulls.review Open Graph image

pulls.review

[!WARNING] Heavily work in progress.

Pull request review made simple. Groups changed files, summarizes what matters, and reviews them one scope at a time.

Use on Website

To use pulls.review on the website, simply visit pulls.review and follow the instructions to connect your GitHub account and start reviewing pull requests directly in your browser.

Use in GitHub

You can optionally install userscript to enhance the GitHub interface with pulls.review features.

Go to pulls.review and scroll down to the GitHub section to install the userscript.

Analyze pull requests from CI (Experimental)

Instead of each reviewer spending their own model key, let a workflow analyze every pull request once and post the result as a PR comment. pulls.review picks the comment up automatically for everyone who opens the PR there. Re-runs on an unchanged PR skip the model call.

# .github/workflows/pulls-review.yml
name: pulls.review
on:
  # The analysis only reads the diff through the API and never checks out PR code,
  # so `pull_request_target` is safe here and lets fork PRs get a comment too.
  pull_request_target:
    types: [opened, synchronize, reopened]

permissions:
  pull-requests: write

jobs:
  analyze:
    runs-on: ubuntu-latest
    steps:
      - uses: antfu/pulls.review@main
        with:
          api-key: ${{ secrets.VERCEL_AI_GATEWAY_API_KEY }}

provider is inferred from the key you pass (gateway for a Vercel AI Gateway token, anthropic, or openai-compatible with base-url); set it explicitly, along with model and locale, when you want to.

The action is a thin wrapper around the @pulls.review/actions CLI, which works anywhere a GitHub token and a model key are in the environment:

GITHUB_TOKEN=... ANTHROPIC_API_KEY=... npx @pulls.review/actions owner/repo#123

Every variable also has a PULLS_REVIEW_* form that takes precedence (PULLS_REVIEW_GITHUB_TOKEN, PULLS_REVIEW_PROVIDER, PULLS_REVIEW_API_KEY, PULLS_REVIEW_MODEL, PULLS_REVIEW_BASE_URL, PULLS_REVIEW_LOCALE); npx @pulls.review/actions --help lists everything.

Packages

Package What it is
packages/app The site at pulls.review and the github.com embed.
@pulls.review/core Fetching, parsing, grouping and summarizing diffs - runs in the browser and in Node.
@pulls.review/actions The CLI the GitHub Action runs.
pulls.review The standalone CLI for reviewing local git changes. Not implemented yet - the name is reserved.

Credits

Inspired heavily by Linear's PR review guides, thanks for the inspiration.

Sponsors

Sponsors

License

MIT License

pulls.review (antfu/pulls.review)

Searching Database…

546 ·GitHub
Pulls.review
Что это?pulls.review — инструмент для ревью пулл-реквестов: он группирует изменённые файлы по областям (scope), резюмирует важное и позволяет ревьюить PR по одной области за раз, вместо прокрутки всего диффа.
Это сайт, браузерный скрипт или инструмент для CI?На самом деле всё сразу: веб-приложение на pulls.review, опциональный юзерскрипт, дополняющий интерфейс GitHub.com, и GitHub Action для анализа в CI; отдельный локальный CLI тоже запланирован, но пока не реализован.
С чего начать ревьюить PR с этим инструментом?Зайдите на pulls.review, подключите аккаунт GitHub и начните ревьюить пулл-реквесты прямо в браузере; можно также установить юзерскрипт из раздела GitHub на сайте, чтобы перенести возможности на сам github.com.
Достаточно ли это стабильно, чтобы сейчас на него полагаться?Нет, сам README предупреждает, что проект находится в активной разработке, а пакет отдельного CLI — просто зарезервированное имя, которое пока не реализовано.
Что реально делает GitHub Action?Он запускает workflow, который один раз анализирует каждый пулл-реквест выбранной вами моделью и публикует результат комментарием в PR, который pulls.review автоматически подхватывает для каждого ревьюера, открывшего этот PR; повторный запуск на неизменившемся PR пропускает вызов модели.
Какие у проекта пакеты?Репозиторий — монорепо: packages/app — это сайт pulls.review и GitHub-эмбед, @pulls.review/core отвечает за получение, разбор, группировку и резюмирование диффов, а @pulls.review/actions — это CLI, который запускает GitHub Action.
Что вдохновило pulls.review?Автор говорит, что на проект сильно повлияли гайды по ревью пулл-реквестов от Linear.
Можно использовать любого ИИ-провайдера?Да, поддерживаются Anthropic, эндпоинты, совместимые с OpenAI, с кастомным base-url, или токен Vercel AI Gateway, а провайдер определяется автоматически по предоставленному ключу.
What are similar projects?claude-code-action, eve-software-factory-template, pr-agent, open-swe, jev-code-reviewer, open-code-review, github-mcp-server, pr-lens
Which topics is it in?pull-request, userscript, vercel, ci-cd, code-review, github-actions, monorepo, github, anthropic, browser, web-app, openai
Creator
antfu
Size
2.5 MB
Stars
546
Updated
CommitOct 13Releasev0.3.3Oct 13
Age
1mo
Commits · 90 Days