visual-baselines.yml

name: Update visual baselines

on:
  push:
    branches: [master]
  workflow_dispatch:

jobs:
  baselines:
    name: Capture and publish baselines
    runs-on: ubuntu-latest
    container:
      image: cypress/browsers:latest
      options: --user 1001
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - uses: pnpm/action-setup@v6
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'pnpm'

      - name: Cache Cypress binary
        uses: actions/cache@v5
        with:
          path: ~/.cache/Cypress
          key: ${{ runner.os }}-cypress-${{ hashFiles('regression-test/package-lock.json') }}

      - name: Build InstUI
        run: pnpm install --frozen-lockfile && pnpm run bootstrap

      - name: Install regression-test dependencies
        run: npm ci
        working-directory: regression-test

      - name: Install Cypress binary
        run: npx cypress install
        working-directory: regression-test

      # Capturing baselines is decoupled from the a11y/console assertions: the
      # screenshots are valid renders regardless of whether those assertions
      # pass, so a failing test must never block the baseline refresh (that's
      # what silently froze the baselines branch before). We let Cypress fail
      # here, always publish the screenshots below, then re-surface the failure
      # in a trailing step so master still shows red and notifies.
      - name: Run Cypress
        id: cypress
        continue-on-error: true
        uses: cypress-io/github-action@v7
        env:
          ELECTRON_EXTRA_LAUNCH_ARGS: "--remote-debugging-port=9222"
        with:
          install: false
          build: npm run build
          start: npm start
          working-directory: regression-test

      - name: Flatten screenshots
        if: always()
        run: |
          mkdir -p baseline-publish/screenshots
          find regression-test/cypress/screenshots -name '*.png' -exec cp {} baseline-publish/screenshots/ \;

      - name: Push baselines to visual-baselines branch
        if: always()
        run: |
          cd baseline-publish
          git init -b visual-baselines
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add screenshots/
          git commit -m "update baselines from ${GITHUB_SHA}"
          git remote add origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
          git push --force origin visual-baselines

      # Baselines have been refreshed by this point; now fail loudly if the
      # suite had regressions (a11y/console violations or a broken page) so the
      # failure is visible on master rather than silently swallowed.
      - name: Fail if Cypress reported failures
        if: steps.cypress.outcome == 'failure'
        run: |
          echo "::error::Baselines were published, but the regression suite had failing tests (a11y/console/spec). See the Run Cypress step logs."
          exit 1