CI/CD Integration
Automated UX quality gates in every pull request - catch regressions before they reach production
CI/CD Integration
Integrate VertaaUX audits into your CI/CD pipeline to catch UX regressions before they reach production. Every pull request gets automated quality checks, every deployment gets verified.
Why CI/CD Integration?
| Benefit | What It Means |
|---|---|
| Catch regressions | Fail builds when UX score drops below thresholds |
| Prevent new issues | Block PRs that introduce accessibility errors |
| Track improvements | Compare against baselines to measure progress |
| Enforce standards | Policy-as-code for branch-specific quality rules |
How It Works
- Developer opens a pull request
- CI deploys to a preview environment
- VertaaUX audits the preview URL
- Results determine pass/fail status
- PR comments show issues (optional)
- Merge blocked until quality gates pass
Key Features
Quality Gates
Configurable thresholds for score, error counts, and regressions
Policy-as-Code
Branch-specific rules with vertaa.policy.yml
Baseline Tracking
Compare new vs existing issues for fair PR evaluation
PR Comments
Inline feedback with issue details and trends
Choose Your CI Platform
GitHub Actions
Full workflow examples with preview deployments, PR comments, and baseline management
GitLab CI
GitLab CI/CD integration with merge request support
CircleCI
CircleCI configuration with orb-style setup
Jenkins
Declarative and scripted pipeline examples
Azure DevOps
Azure Pipelines with variable groups
Prerequisites
Before setting up CI/CD integration:
- CLI installed - See CLI Installation
- API key - Get one from Dashboard Settings and add as
VERTAA_API_KEYsecret - Preview URL - Your CI must deploy to a preview environment (Vercel, Netlify, etc.)
The CLI handles authentication automatically when the VERTAA_API_KEY environment variable is set.
Simplest Integration
The minimal CI integration is one command:
npm install -g @vertaaux/cli && vertaa audit -u $PREVIEW_URL --fail-on errorThis installs the CLI, audits your preview URL, and fails the build if errors are found.
Exit Codes
The CLI uses exit codes for CI integration:
| Code | Meaning | Use Case |
|---|---|---|
0 | Success | All checks passed |
1 | Issues found | --fail-on triggered or --max-new-* exceeded |
2 | Error | Network error, invalid URL, auth failure |
3 | Score below threshold | --threshold value not met |
Next Steps
Quickstart
Run your first CI audit in 5 minutes
Policy Reference
Configure branch-specific quality rules
Also Available
The VertaaUX CLI powers CI/CD integration. For CLI-specific documentation:
| Resource | Description |
|---|---|
| CLI Reference | Complete CLI documentation |
| CLI Commands | All available commands |
| API Authentication | API key management |
Was this page helpful?