Accessibility: Add storybook a11y tests that run in CI (#108543)

* add test runner and start experimenting with storybook a11y tests * skip currently failing a11y tests * first attempt at github action * fix CODEOWNERS, fix copy assets * no caching? * make wait-on better * increase timeout and add verbose logging * kick CI * remove verbose logging, try different runner * remove commented out code in copyAssets * try maxWorkers 2 * turn on verbose logging, run as part of same step * test storybook verify * try setting LANG * tidy up * add betterer test
2025-07-24 16:32:02 +01:00
parent 512a553723
commit 2be4e44a02
60 changed files with 1353 additions and 66 deletions
@@ -0,0 +1,57 @@
+name: Run Storybook a11y tests
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - release-*.*.*
+
+permissions: {}
+
+jobs:
+  detect-changes:
+    name: Detect whether code changed
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      changed: ${{ steps.detect-changes.outputs.frontend }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: true # required to get more history in the changed-files action
+          fetch-depth: 2
+      - name: Detect changes
+        id: detect-changes
+        uses: ./.github/actions/change-detection
+        with:
+          self: .github/workflows/storybook-a11y.yml
+
+  test-storybook-a11y:
+    runs-on: ubuntu-latest-8-cores
+    permissions:
+      contents: read
+      id-token: write
+    needs: detect-changes
+    if: needs.detect-changes.outputs.changed == 'true'
+    name: "Run Storybook a11y tests"
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+    - run: yarn install --immutable --check-cache
+    - name: Install Playwright browsers
+      run: npx playwright install --with-deps
+    - name: Start Storybook
+      run: yarn storybook &
+    - name: Run tests
+      # the chromium browser used by Playwright sets its locale to "en_US@posix" by default
+      # this is not a valid language code, and causes some stories to fail to load!
+      # instead, we set the LANG environment variable to en_US to override this
+      # see https://github.com/microsoft/playwright/issues/34046
+      env:
+        LANG: en_US
+      run: npx wait-on --timeout 120000 http://localhost:9001 && yarn test:storybook