docs-test-a11y.yml

name: docs
run-name: Test doc site a11y

on:
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - ".github/workflows/docs-test-a11y.yml"

env:
  JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
  testing:
    name: test a11y
    runs-on: ubuntu-latest

    steps:
      - name: Checkout source
        uses: actions/checkout@v2

      - name: Install Node
        uses: actions/setup-node@v2
        with:
          node-version: '16'

      - name: Install Ruby
        uses: ruby/setup-ruby@v1
        with:
          working-directory: docs
          ruby-version: 3.1.3
          bundler-cache: false

      - name: Install GEMs
        working-directory: docs
        env:
          BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
        run: |
          pwd
          bundle install

      - name: Build site
        working-directory: docs
        env:
          BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
        run: bundle exec jekyll build

      - name: Serve site
        working-directory: docs
        env:
          BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
        run: bundle exec jekyll serve --detach

      - name: Show environment
        working-directory: docs
        run: npx pa11y --environment

      - name: Test accessibility
        working-directory: docs
        run: |
          npx pa11y-ci \
            --sitemap http://127.0.0.1:4000/sitemap.xml \
            --sitemap-exclude "/*.pdf"