GitLab

The GitLab integration posts visual test results on your merge requests.

Setup

Navigate to Settings > Integrations and configure the GitLab card.

1. Enter your GitLab project URL
2. Provide a Personal Access Token (PAT) with api scope
3. Select which events trigger notifications (defaults include run.started)
4. Click Save

You can update the token later without reconfiguring the rest of the integration.

CI pipeline

VisualQ provides a ready-to-use .gitlab-ci.yml snippet:

visual-test:
  image: node:20
  script:
    - npx @visualq/cli run --api-key $VISUALQ_API_KEY --project my-website --ci gitlab

Add VISUALQ_API_KEY as a CI/CD variable in your GitLab project settings.

Features

• MR comments with visual test results
• Links to the Diff Viewer for each failed scenario
• Status updates on merge request pipelines

Requirements

• Pro plan or higher
• GitLab project with API access (PAT with api scope)