Skip to main content
ScanU.eu

Quick Start

  1. Create a project in ScanU dashboard.
  2. Open Settings → API Keys and create a token for that project.
  3. Add two GitHub repository secrets: SCANU_TOKEN and SCANU_PROJECT_ID.
  4. Create a workflow file in .github/workflows/visual-regression.yml.
  5. Open a PR and wait for the ScanU check + PR comment with links.
yaml
name: Visual checks
on:
  pull_request:

jobs:
  visual-regression:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
      issues: write
    steps:
      - uses: actions/checkout@v4

      - name: Run ScanU
        uses: scanyou/scanu-action@v1
        with:
          token: ${{ secrets.SCANU_TOKEN }}
          project_id: ${{ secrets.SCANU_PROJECT_ID }}
          urls: |
            https://staging.example.com

Run a test integration checklist

  • âś… Workflow appears in GitHub Actions tab.
  • âś… Job creates a ScanU run and prints run_id output.
  • âś… PR receives a ScanU comment.
  • âś… Intentional UI change makes check fail when fail_on_diff: true.