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 Vercel/Railway preview deployments

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 Integration

1

Enable Preview Access

In your Vercel project settings, add the Vercel protection bypass key to your Bugster configuration
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

​
Railway Integration

1

Configure Preview Deployments

Ensure Railway preview deployments are enabled for your project
2

Set Environment Variables

Configure necessary environment variables for your Railway previews

Railway Setup Guide

Complete Railway integration and deployment configuration

​
How It Works

​
Pull Request Workflow

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

​
Test Execution

​
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

​
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 Guide

Complete Vercel integration and deployment configuration

Railway Setup Guide

Complete Railway integration and deployment configuration