GitHub Integration
Automatically run tests on deployments with GitHub App integration
Recommended: Install the Bugster GitHub App to enable automatic test runs on every Vercel preview for your pull requests. Go to the GitHub Integration section in the Overview page at gui.bugster.dev, click Manage Integrations, and grant access to your repository.
Bugster integrates with GitHub to automatically run tests when deployments are created, providing immediate feedback on your application’s functionality.
How to Set Up GitHub Integration
Open the Bugster Dashboard
Go to https://gui.bugster.dev and select your project.
Go to GitHub Integration
In the Overview page, find the “GitHub Integration” section and click Manage Integrations.
Install the GitHub App
Follow the prompts to install the Bugster GitHub App and grant access to the specific repository you want to connect.
You must grant access to specific repositories only. Granting access to all repositories won’t work with Bugster.
Initialize Bugster (if not already)
Your repository must have a .bugster
folder in the root directory:
Vercel Setup (if applicable)
If using Vercel previews, disable preview protection to allow Bugster access.
We’re working on implementing bypass protection features to avoid this requirement.
The base URL you provide during bugster init
is used for running tests locally or in your dev environment. With GitHub integration, Bugster will automatically run tests on your Vercel preview deployments for each pull request and report results directly in your PRs.
How It Works
Bugster automatically runs tests when GitHub receives a deployment_status
event. This happens with:
- Vercel deployments - Tests run when preview deployments are ready
- GitHub Actions with environments - Tests run when using GitHub environments
- Any platform that triggers GitHub deployment events
Tests run on any deployment, not just pull requests. If there’s an open PR for that deployment, results will be posted as comments.
Vercel Integration
When you push to any branch:
- Vercel creates a preview deployment
- GitHub receives the deployment event
- Bugster automatically runs tests against the preview URL
- If there’s an open PR, results are posted as comments
GitHub Actions Integration
Use GitHub environments in your deployment workflow:
Key points:
- The
environment
section is required - Tests run against the
url
specified in the environment - If no URL is provided, tests use the
base_url
from.bugster/config.yaml
Configuration
Ensure your .bugster/config.yaml
has the correct base URL as fallback:
Supported Platforms
Any deployment platform that triggers GitHub’s deployment_status
event:
- ✅ Vercel
- ✅ GitHub Actions with environments
- ✅ Most major deployment platforms
Most deployment platforms support GitHub deployment events, but we’ve specifically tested with Vercel and GitHub Actions.
Test Results
Results appear as:
- Comments on pull requests (when applicable)
- Status checks on commits
- Detailed reports in your Bugster dashboard