Skip to main content

GitHub Integration

Connect QA Proof with GitHub to automatically create issues for visual bugs and run design QA checks on pull requests.

Connecting GitHub

  1. Go to Settings → Integrations
  2. Click "Connect GitHub"
  3. Authorize the QA Proof GitHub App
  4. Select which repositories to grant access to

Automatic Issue Creation

When QA Proof detects visual issues, it can automatically create GitHub issues:

  • Issues include screenshots showing the difference
  • Severity labels are applied automatically
  • Issues link back to the QA Proof test results for full details

Enable this in Project Settings → GitHub → Auto-create issues.

PR Status Checks

QA Proof can run design QA tests on every pull request:

  1. Enable "PR Checks" in your GitHub integration settings
  2. Select which test suites to run on PRs
  3. QA Proof posts results as a status check on the PR
  4. Optionally require passing visual tests before merging

PR Comments

QA Proof posts a summary comment on each PR with:

  • Number of visual differences detected
  • Screenshot comparisons for changed pages
  • Links to full results in the QA Proof dashboard

Managing the Connection

To modify repository access or disconnect, go to Settings → Integrations → GitHub. You can also manage the QA Proof app directly from your GitHub organization settings.