GitHub App
Automated PR reviews powered by Scrubby's codebase intelligence. Every pull request gets analyzed for forgotten files, convention violations, and cross-domain issues.
The Scrubby GitHub App reviews every pull request against your codebase’s actual patterns. It runs independently of your editor integration, so even teams that don’t use AI editors get the benefit.
Installation
1. Install the app
Go to github.com/apps/scrubbyai and click Install. Choose the organization and the repositories you want Scrubby to review. You can install on individual repos or all repos in an org — the app will only review what you grant access to.
2. Index your repositories
The GitHub App needs an indexed repository before it can review PRs. You can index from your AI editor (ask it to run scrubby_index) or from the dashboard’s repositories page. Indexing takes 1–3 minutes; you’ll get an email when it finishes.
3. Open a pull request
That’s it. From the next PR onward, Scrubby creates a check run, analyzes the changeset, and posts findings as a PR comment plus inline suggestions where applicable.
What Scrubby reviews
When a pull request is opened, synchronized, or reopened, Scrubby runs three layers of analysis.
Changeset analysis
- Co-change gaps. Files that historically change together but are missing from this PR. The classic catch: you updated the model but forgot the migration. Threshold and full mechanics in Co-Change Analysis.
- Consistency warnings. Common patterns that look broken — a route added without a controller action, a service modified without its tests.
- Domain crossings. Changes that touch multiple architectural domains, highlighted because they often need additional review.
Per-file analysis
- Convention violations. Code that doesn’t match the conventions for that file’s segment.
- Inline suggestions. Specific code changes posted as GitHub suggestion blocks — you can accept and commit them directly from the PR.
Status checks
Scrubby creates a GitHub Check Run on each PR. The check progresses from “in progress” through “completed”, with a summary of findings. You can require this check to pass via GitHub branch protection rules.
Permissions
The Scrubby GitHub App requests minimal permissions:
| Permission | Access | Why |
|---|---|---|
| Pull requests | Read & write | Read PR metadata; post review comments and inline suggestions |
| Checks | Read & write | Create and update the Scrubby check run |
| Contents | Read | Read file contents and commit history for analysis |
Scrubby never writes to your code — suggestions appear as proposed changes you opt into.
Webhook events handled
Scrubby subscribes to:
pull_request— actions:opened,synchronize,reopened. Triggers a PR analysis job.installation— install / uninstall.installation_repositories— repo added or removed from the install scope.
For the full payload contract see Webhook Payloads.
Configuration
Most of the GitHub App’s behavior is automatic. From your dashboard you can:
- See which repos are installed and which are indexed.
- Trigger a manual re-index for any installed repo.
- Adjust audit preferences (digest frequency, severity thresholds).
Troubleshooting
If Scrubby’s check run never appears, see PR Review Didn’t Run. If indexing is stuck, see Indexing Stuck or Failing.
Last updated