Audits

Scrubby runs a weekly codebase audit on each indexed repository and reports what it finds.

What an audit checks

An audit runs across a whole indexed repository at once, rather than a single pull request, and collects three kinds of findings:

• Architecture concerns: issues spanning the codebase's structure.
• Domain issues: findings tied to specific domains.
• Convention violations: code that departs from the repository's learned conventions.

Each finding carries a severity. Audits run automatically once a week; every indexed repository is audited on the schedule.

Where results are delivered

Depending on your audit notification preferences (below), a completed audit can be delivered in up to three places:

• Dashboard: results are always stored and shown in the Recent Audits section of your Account page, with per-category and per-severity counts.
• Email digest: a weekly summary email covering the repositories you can access, sent after the audit run completes.
• GitHub issue: for a repository with the GitHub App installed, the audit can open an issue labeled scrubby-audit with its findings. An audit that finds nothing does not open an issue.

Audit notification preferences

The Audit Notifications section of the Account page has a toggle for each delivery channel (GitHub issues, email digest, and dashboard). Turn any of them on or off; the dashboard record is what the Recent Audits section reads from.

Running an audit now

Alongside the weekly schedule, you can trigger an audit on demand from the dashboard rather than waiting for the next scheduled run. You can audit a single repository or all of your indexed repositories at once. The dashboard also shows when the next scheduled audit will run.