GitHub

Pro plan

The GitHub integration posts visual test results as PR checks and comments on your pull requests.

Setup

Go to Integrations

Navigate to Settings > Integrations in your project.

Click Connect GitHub

Click the GitHub card. You'll be redirected to GitHub to install the VisualQ GitHub App.

Authorize the app

Select the repositories you want to connect and authorize the installation.

Select repository

Back in VisualQ, select the repository owner and repo name for the integration.

What you get

Check runs on pull requests showing pass/fail status
Comments with a summary of visual differences and a link to the Diff Viewer
Automatic association of test runs with commits and PRs

CI workflow

Once connected, VisualQ provides a ready-to-use GitHub Actions workflow snippet that you can add to your repository:

name: Visual Tests
on: [pull_request]

jobs:
  visual-test:
    runs-on: ubuntu-latest
    steps:
      - uses: abecms/visualq-action@v1
        with:
          api-key: ${{ secrets.VISUALQ_API_KEY }}
          project: my-website

Requirements

A GitHub repository connected to your VisualQ project
Pro plan or higher
The VisualQ GitHub App installed on your repository