Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.testsprite.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Connecting TestSprite to GitHub turns one-off testing into a release gate. Once installed, the integration watches your selected repositories and runs tests automatically on every pull request — surfacing results as PR comments and (optionally) blocking merges until tests pass.
config

​
What the Integration Does

Once a repository is connected, TestSprite can:
  • Run tests on every pull request to that repo
  • Optionally include draft PRs in the watch list
  • Post results back as PR comments with pass/fail counts and links to the full report
  • Optionally block merge until the tests pass — turning the integration into a quality gate
Each behavior is configurable per repository, so a repo you’re still experimenting with can run non-blocking while a release-critical repo enforces the gate.

​
Installation

1

Open the GitHub App settings

Navigate to Settings → GitHub App in the dashboard. If the integration isn’t installed yet, you’ll see a banner with a Connect With Github App button.
config
2

Connect

Click Connect With Github App. A GitHub popup opens where you choose:
  • The GitHub account or organization to install into
  • Repository access — every repo in the account or a selected subset
GitHub will ask you to authorize the TestSprite GitHub App. Approve to continue.
config
3

Return to TestSprite

Once you complete the GitHub flow, the popup closes and the settings page refreshes automatically. You’ll now see a Connected Organization card showing the GitHub account and a list of connected repositories.
config
You can install into multiple GitHub accounts or organizations. Each shows up as its own Connected Organization card on the settings page.

​
Configuring a Repository

After installation, each repository you give access to can be configured independently.
1

Select the repository

From the connected repositories list, expand the row for the repo you want to configure (or click Add Connection for a new one).
config
2

Configure run behavior

config
Three toggles per repository:
ToggleDefaultEffect
Run on Pull RequestsOnTestSprite runs your tests when a PR is opened or updated
Include Draft PRsOnRun on draft PRs in addition to ready-for-review ones
Blocking PRsOnReport results as GitHub Status Checks; failures prevent the PR from being merged
3

Save

Click Save Changes. The repo is now wired up — the next PR opened or updated will trigger a TestSprite run.
config

​
Disconnecting a Repository

To stop testing a specific repository without uninstalling the whole app, expand that repo’s card and click Remove, then confirm with Revoke. The repo’s TestSprite runs stop immediately; existing run history stays accessible.

​
Uninstalling the App Entirely

To remove the integration completely:
  1. From GitHub, go to Settings → Applications → Installed GitHub Apps
  2. Find TestSprite and click Configure
  3. Scroll to the bottom and click Uninstall
The TestSprite settings page reverts to the not-yet-installed state. Reinstall any time to start over.

​
Tips

Turn off Blocking PRs for the first few PRs while you confirm tests run cleanly. Flip blocking on once you’re confident the suite is stable.
The integration runs tests that already exist for your project. The fastest way to seed tests for a repo is via the TestSprite MCP server in your IDE — generate, validate, push, and the integration picks up from there.
Leaving Include Draft PRs on means you can open a draft against your branch to get a TestSprite run without ceremony. Useful for “I’m about to refactor — does the suite pass first?” sanity checks.
PR checks catch regressions before merge; scheduled runs catch regressions in production. Most teams run both.

​
Where to Go Next

Monitoring & Scheduling

Run tests on a schedule, not just on PRs

API Keys

Other ways to integrate TestSprite with external tools

MCP Server

Generate tests from your IDE first

Test Detail

Where PR-triggered runs land