Skip to content
Reccy Logo
Homepage Documentation Guides

CI Setup

Reccy tests your pull requests by simulating user sessions against both the base and head commits, then comparing the results. This requires running on:

  • Pull request branches — To test the changes
  • Main branch — To generate baseline screenshots for comparison

The below GitHub integration will automatically pick up Vercel preview environment URLs as they are created, and tests will be run against the base (production) and head (preview) deployments.

During signup you should have already installed the Reccy Github App and linked a GitHub repository with your project. This means that you’re already setup to automatically run tests on pull requests to that repository!

To require approval of visual diffs before merging:

  1. Go to your repository’s Settings > Branches
  2. Add or edit a branch protection rule for main
  3. Enable “Require status checks to pass”
  4. Add the Reccy check to required checks

When simulating sessions, Reccy swaps the origin URL while preserving paths and query parameters:

Recorded: https://production.example.com/dashboard?tab=settings
Simulated: https://preview-123.vercel.app/dashboard?tab=settings

Important: This applies to navigation and API requests only. Static assets with absolute URLs are not rewritten. Use relative URLs for assets to ensure cross-environment compatibility.

Additional URL rewrites can be configured in the project settings under “Domain Mappings”.

For accurate comparisons, ensure these are consistent between main branch (production) and PR (preview) deployments:

  • Environment variables
  • Feature flag states
  • Authentication configuration

Differences between environments will appear as false-positive diffs.