Skip to main content
VertaaUX Docs

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?

BenefitWhat It Means
Catch regressionsFail builds when UX score drops below thresholds
Prevent new issuesBlock PRs that introduce accessibility errors
Track improvementsCompare against baselines to measure progress
Enforce standardsPolicy-as-code for branch-specific quality rules

How It Works

  1. Developer opens a pull request
  2. CI deploys to a preview environment
  3. VertaaUX audits the preview URL
  4. Results determine pass/fail status
  5. PR comments show issues (optional)
  6. Merge blocked until quality gates pass

Key Features

Choose Your CI Platform

Prerequisites

Before setting up CI/CD integration:

  1. CLI installed - See CLI Installation
  2. API key - Get one from Dashboard Settings and add as VERTAA_API_KEY secret
  3. 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 error

This 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:

CodeMeaningUse Case
0SuccessAll checks passed
1Issues found--fail-on triggered or --max-new-* exceeded
2ErrorNetwork error, invalid URL, auth failure
3Score below threshold--threshold value not met

Next Steps


Also Available

The VertaaUX CLI powers CI/CD integration. For CLI-specific documentation:

ResourceDescription
CLI ReferenceComplete CLI documentation
CLI CommandsAll available commands
API AuthenticationAPI key management

Was this page helpful?

On this page