pa11y-accessibility-check-all-website-html #2
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: pa11y-accessibility-check-all-website-html | |
| on: | |
| workflow_dispatch: | |
| jobs: | |
| accessibility_assessment_all_website_html: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: mcr.microsoft.com/playwright:v1.42.1-jammy # includes Chromium, Node, and tools | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11.6' | |
| - name: Install Poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| echo "$HOME/.local/bin" >> $GITHUB_PATH | |
| - name: Install dependencies | |
| run: | | |
| export PATH="$HOME/.local/bin:$PATH" | |
| poetry install | |
| - name: Cache executed notebooks | |
| uses: actions/cache@v4 | |
| with: | |
| path: _build/.jupyter_cache | |
| key: jupyter-book-cache-${{ hashFiles('pyproject.toml') }} | |
| - name: Build the book | |
| run: poetry run jupyter-book build . | |
| - name: Upload error logs | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: error-logs | |
| path: _build/html/reports/pathways/related_courses.err.log | |
| continue-on-error: true | |
| - name: Install Node.js and dependencies | |
| run: | | |
| apt-get update | |
| apt-get install -y curl gnupg jq findutils | |
| curl -fsSL https://deb.nodesource.com/setup_20.x | bash - | |
| apt-get install -y nodejs | |
| npm install --save-dev pa11y-ci | |
| npx puppeteer browsers install chrome | |
| - name: Identify all HTML files in _build/html | |
| id: map_html_targets | |
| shell: bash | |
| run: | | |
| find _build/html -type f -name '*.html' | jq -R . | jq -s . > pa11y_targets.json | |
| echo "Generated pa11y_targets.json:" | |
| cat pa11y_targets.json | |
| - name: Run Pa11y CI on changed pages only and save output | |
| id: run_pa11y | |
| shell: bash | |
| run: | | |
| num_files=$(jq length pa11y_targets.json) | |
| touch pa11y_output.md | |
| if [ "$num_files" -eq 0 ]; then | |
| echo "No relevant HTML files to check. Skipping Pa11y." | tee pa11y_output.md | |
| else | |
| echo "### 🚦 Pa11y Accessibility Report" > pa11y_output.md | |
| echo "" >> pa11y_output.md | |
| mapfile -t html_files < <(jq -r '.[]' pa11y_targets.json | sort -u) | |
| total_files=${#html_files[@]} | |
| for i in "${!html_files[@]}"; do | |
| file="${html_files[$i]}" | |
| current_index=$((i + 1)) | |
| echo "🔎 Checking $current_index of $total_files: $file" | |
| echo "#### 📄 $file" >> pa11y_output.md | |
| echo '```' >> pa11y_output.md | |
| result=$(npx pa11y-ci --reporter cli --config pa11yci.js "file://$(pwd)/$file" 2>&1 || true) | |
| echo "$result" >> pa11y_output.md | |
| echo '```' >> pa11y_output.md | |
| base=$(basename "$file" .html) | |
| echo "_⚠️ Any errors likely originates from the source file (e.g., \`filename.md\`, \`filename.ipynb\`) used to generate the HTML._" >> pa11y_output.md | |
| echo "" >> pa11y_output.md | |
| done | |
| fi | |
| - name: 🔍 Debug comment body | |
| run: | | |
| echo "------- BEGIN COMMENT BODY -------" | |
| cat pa11y_output.md | |
| echo "-------- END COMMENT BODY --------" | |