loremm34/Visual Regression Check
Run visual regression tests against your site and get PR comments with diff screenshots
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | VR API key (Settings → API Keys in the dashboard) | yes | — |
| project-id | VR project ID (UUID from the dashboard) | yes | — |
| site-url | Production URL of your site (e.g. https://my-app.com) | yes | — |
| preview-url | Explicit preview URL to test against for pull requests. Use this if your platform does not register GitHub Deployments automatically (e.g. custom CI, AWS, self-hosted). When provided, auto-detect is skipped. | no | "" |
| auto-detect-preview | Automatically find the PR preview URL via the GitHub Deployments API. Works out of the box with Vercel, Netlify, Render — any platform that registers deployments to GitHub. Set to "false" to always test against site-url. | no | true |
| preview-environment | GitHub Deployment environment name to look for when auto-detecting the preview URL. Default "Preview" works for Vercel and Netlify. Change if your platform uses a different name (e.g. "preview", "staging", "pr-preview"). | no | Preview |
| preview-bypass-secret | Secret token to bypass preview deployment authentication. Vercel: enable "Protection Bypass for Automation" in Project → Settings → Deployment Protection, copy the secret, add it as a repo secret, and pass it here. It will be appended as ?x-vercel-protection-bypass=SECRET to the preview URL. Other platforms: leave empty (most don't restrict preview access by default). | no | "" |
| backend-url | Visual regression backend URL | no | https://web-production-52de4.up.railway.app |
| suite | Test suite name (used for grouping results in the dashboard) | no | website |
| pages | JSON array of pages to test. Example: [{"name": "Home", "path": "/"}, {"name": "Login", "path": "/login", "wait_ms": 200}] Each page: name (string), path (string), key (optional), wait_ms (optional), threshold (optional). | no | "" |
| config-file | Path to a JSON config file in your repo (alternative to inline pages input) | no | "" |
| threshold | Allowed pixel difference ratio (0.0–1.0). Default: 0.1 (10%) | no | 0.1 |
| detect-noise | Auto-ignore animated regions like spinners and cursors. Default: true | no | true |
Outputs
no outputs