visual-regression-tests.yml

name: Visual regression tests

on:
  push:
    branches:
      - main
    paths-ignore: # Until anchors are supported by GitHub Actions, we have to write this list twice.
      - ".github/**"
      - "docs/**"
      - ".gitignore"
      - "startup.sh"
      - "CHANGELOG.md"
      - "README.md"
      - "LICENCE.md"
      - "SUPPORT.md"
  pull_request:
    paths-ignore:
      - ".github/**"
      - "docs/**"
      - ".gitignore"
      - "startup.sh"
      - "CHANGELOG.md"
      - "README.md"
      - "LICENCE.md"
      - "SUPPORT.md"
  workflow_dispatch:
    inputs:
      ref:
        description: 'The branch, tag or SHA to checkout'
        default: main
        type: string

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name || github.run_id }}
  cancel-in-progress: true

jobs:
  visual-regression-test-components:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ inputs.ref || github.ref }}
      - uses: ruby/setup-ruby@v1
        with:
          bundler-cache: true # Also runs `bundle install`
      - uses: actions/setup-node@v4.1.0
        with:
          node-version: lts/* # use the latest LTS release
          cache: yarn
      - run: yarn install --frozen-lockfile
      - run: bundle exec rake app:dartsass:build
      - run: yarn run percy exec -- bundle exec rspec --tag visual_regression
        env:
          PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
          MAIN_COMPONENT_GUIDE: true