GitHub Integration

Connect Bug0 to GitHub for PR comments, commit status checks, and seamless CI/CD integration.

Features

When GitHub is connected:

PR Comments - Automatic test result summaries on pull requests
Commit Status - Pass/fail status on commits
Repository Access - Connect specific repos to projects

Setting Up GitHub

Step 1: Install GitHub App

Go to your Workspace Settings
Click Connect GitHub
You'll be redirected to GitHub
Select your organization or personal account
Choose which repositories to grant access
Click Install

Step 2: Connect Repository to Project

Open your project
Go to Project Settings → Integrations → GitHub
Select the repository from the dropdown
Click Connect

You can only connect repositories that the GitHub App has access to. Add more repositories in GitHub's app settings if needed.

PR Comments

When tests run with PR information, Bug0 comments on the PR:

🤖 Bug0 QA Agent

✅ All tests passed

- Tests completed in 2m 34s
- 12 tests across 3 suites

📊 [View full report](https://reports.bug0.com/...)

For failures:

🤖 Bug0 QA Agent

❌ 2 tests failed

- Tests completed in 3m 12s
- 10 passed, 2 failed

Failed tests:
- User Login > Should redirect to dashboard
- Checkout > Should process payment

📊 [View full report](https://reports.bug0.com/...)

Commit Status

Bug0 updates commit status:

Status	Description
✅ Success	All tests passed
❌ Failure	One or more tests failed
⏳ Pending	Tests are running

The status appears on:

Pull request checks
Commit details
Branch protection

Branch Protection

Use Bug0 status for branch protection:

Go to GitHub repository → Settings → Branches
Add branch protection rule for main
Enable "Require status checks to pass"
Select "Bug0 QA Agent" as required check

Now PRs can't merge until Bug0 tests pass.

Triggering Tests from GitHub

Via GitHub Actions

Use our GitHub Actions workflow to trigger tests on PR events.

Via Deployment Events

Configure deployment triggers when using Vercel, Netlify, or other platforms.

Managing the Integration

View Connection Status

Go to Project Settings → Integrations → GitHub to see:

Connected repository
Last sync status
Available repositories

Change Connected Repository

Open GitHub integration settings
Select a different repository
Save changes

Disconnect GitHub

Open GitHub integration settings
Click Disconnect
Confirm disconnection

To fully remove, also uninstall the GitHub App from GitHub settings.

Passing Git Information

For PR comments and status updates, include git info when triggering tests:

{
  "projectId": "...",
  "gitCommitSha": "abc123def456",
  "gitBranch": "feature/new-checkout",
  "prNumber": "42",
  "owner": "your-org",
  "repo": "your-repo"
}

Troubleshooting

No PR Comments Appearing

Verify GitHub integration is connected
Check repository is selected
Ensure PR number is passed in request
Verify GitHub App has write permissions

Status Not Updating

Check gitCommitSha is correct
Verify repository connection
Check GitHub App permissions

"Repository Not Found"

GitHub App may not have access
Go to GitHub → Settings → Applications
Configure Bug0 app to include the repository

Missing Repositories in Dropdown

GitHub App needs access to those repos
Update GitHub App installation settings
Sync repositories in workspace settings