Skip to main content

CI/CD Pipeline Setup

8 min read Last updated: March 2026

Integrate QA Proof into your CI/CD pipeline to run design QA tests automatically on every deployment or pull request.

Overview

QA Proof provides a CLI tool and API that integrates with any CI/CD platform. Tests run automatically and results are reported back to your version control system.

Getting Your API Key

  1. Go to Settings → API Keys
  2. Click "Generate New Key"
  3. Copy the key and store it as a secret in your CI environment

GitHub Actions

Add this to your workflow file:

- name: Run QA Proof Tests
  uses: qaproof/action@v1
  with:
    api-key: ${{ secrets.QAPROOF_API_KEY }}
    project-id: your-project-id
    suite: regression

GitLab CI

Add a stage to your .gitlab-ci.yml:

design-qa:
  stage: test
  image: qaproof/cli:latest
  script:
    - qaproof run --project your-project-id --suite regression
  variables:
    QAPROOF_API_KEY: $QAPROOF_API_KEY

Other CI Platforms

Use the QA Proof CLI directly:

npm install -g @qaproof/cli
qaproof run --api-key $QAPROOF_API_KEY --project your-project-id

Configuration Options

  • --suite: Which test suite to run
  • --threshold: Fail if match score is below this percentage
  • --wait: Wait for results before continuing (default: true)
  • --notify: Send notifications on completion

Handling Results

The CLI exits with code 0 on success and code 1 on failure, making it easy to gate deployments on visual quality.

💡 Pro Tip: Run visual tests in parallel with your other CI jobs to avoid slowing down your pipeline.