Skip to main content
Connect Bugster to your GitHub repository to automatically run tests on pull requests and preview deployments.

​
What It Enables

Automated Testing

Tests run automatically on every pull request

Preview Testing

Tests against preview deployments from any platform

PR Status Checks

Pass/fail status reported directly in GitHub

Team Visibility

Results visible to all team members

​
Installation

1

Access GitHub Integration

Visit Bugster Dashboard → Your Project → GitHub Integration
2

Install GitHub App

Click “Connect Organization” and authorize the Bugster GitHub App
3

Select Repository

Choose the repository you want to integrate with Bugster
4

Commit Configuration

Add your .bugster/ folder to the repository:
git add .bugster/
git commit -m "Add Bugster CLI configuration"
git push origin main

​
Platform Setup

  • Vercel
  • Railway
  • Netlify
  • GitHub Actions
  • GCP Cloud Build
  • Custom Platform
1

Enable Preview Access

Configure Vercel protection bypass for automated testing access
2

Configure Environment Variables

Ensure your preview deployments have the necessary environment variables for testing

Vercel Setup Guide

Detailed Vercel configuration and protection bypass setup

​
How It Works

​
Pull Request Workflow

  1. PR Created → GitHub notifies Bugster
  2. Preview Deployed → Platform creates preview URL
  3. Tests Execute → Bugster runs tests against preview
  4. Results Reported → Status check appears in GitHub PR

​
Test Execution

New Pull Request: Full test suite executionPush to PR Branch: Affected tests only (smart detection)Preview URL Ready: Tests run against latest deployment
Affected Tests: Only tests related to changed filesAlways-Run Tests: Critical tests that always executeSmart Limits: Respects configured test limits

​
GitHub Status Checks

Results appear as status checks in your pull requests:

​
Status Types

Passed

All tests passed successfully

Failed

One or more tests failed

Pending

Tests are currently running

​
Detailed Results

Click the status check to view:
  • Individual test results
  • Failure reasons and screenshots
  • Execution videos for debugging
  • Performance metrics and timing

​
Troubleshooting

Issue: No status checks appearing on PRsSolution: Reinstall the GitHub App with proper repository permissions
Issue: No test execution triggeredSolutions:
  • Ensure .bugster/ folder is committed to repository
  • Verify GitHub App has access to the correct repository
  • Check that preview deployments are working
Issue: Tests fail to connect to preview deploymentSolutions:
  • Ensure deployment is complete and URL is publicly accessible
  • Vercel: Configure protection bypass correctly
  • Railway: Verify deployment settings and environment variables
  • Netlify: Check webhook configuration and deployment status
  • GitHub Actions/Cloud Build/Custom: Verify environment URL is accessible
  • Check that environment variables are properly configured

​
Best Practices

Repository Setup

Commit configuration: Always commit .bugster/config.yaml and test filesBranch protection: Require Bugster status checks before mergingEnvironment consistency: Match preview and production configurations

Team Workflow

PR testing: Let tests complete before code reviewFailure handling: Investigate and fix test failures promptlyTest maintenance: Keep tests updated with code changes

​
Next Steps

Vercel Setup

Complete Vercel integration and deployment configuration

Railway Setup

Complete Railway integration and deployment configuration

Netlify Setup

Complete Netlify integration with webhook configuration

GitHub Actions Setup

Use official GitHub Action for workflow integration

Cloud Build Setup

Integrate with GCP Cloud Build pipelines

Custom Integration

Build custom integration with webhook API