Barrierefreiheitsprüfung in Ihrer CI

CI einrichten

Das Skript (/ci/equalvia-check.mjs) startet eine Prüfung, wartet auf das Ergebnis und gibt es aus. In GitHub Actions setzt es außerdem Fehler-Annotationen und eine Tabelle in die Job-Zusammenfassung.

GitHub Actions: nach jedem erfolgreichen Preview-Deployment

# .github/workflows/accessibility.yml
name: Accessibility
on: deployment_status

jobs:
  equalvia:
    if: github.event.deployment_status.state == 'success'
    runs-on: ubuntu-latest
    steps:
      - name: EqualVia accessibility check
        env:
          EQUALVIA_API_KEY: ${{ secrets.EQUALVIA_API_KEY }}
          URL: ${{ github.event.deployment_status.target_url }}
        run: |
          curl -fsSL https://equalvia.com/ci/equalvia-check.mjs -o equalvia-check.mjs
          node equalvia-check.mjs "$URL/" "$URL/pricing" "$URL/contact" --fail-on serious

Vercel, Netlify und die meisten Hoster melden Preview-Deployments an GitHub, und genau darauf hört der Trigger deployment_status. Sie möchten eine feste Version des Skripts? Legen Sie eine eigene Kopie ins Repository, statt es bei jedem Lauf herunterzuladen.

GitLab CI: nach dem Job, der die Review-App deployt

# .gitlab-ci.yml (after the job that deploys the review app)
accessibility:
  stage: test
  image: node:20
  variables:
    EQUALVIA_URLS: "$CI_ENVIRONMENT_URL/ $CI_ENVIRONMENT_URL/pricing"
  script:
    - curl -fsSL https://equalvia.com/ci/equalvia-check.mjs -o equalvia-check.mjs
    - node equalvia-check.mjs --fail-on serious

Jede andere CI (Bitbucket, CircleCI, Jenkins, Azure DevOps) funktioniert genauso: Skript herunterladen und mit Node ausführen.

Optionen des Skripts

Exit-Codes

Nur neue Fehler

Kaum eine Website startet mit null Fehlern, und eine CI-Prüfung, die bei jedem Lauf fehlschlägt, wird abgeschaltet. Mit einer Baseline werden die Fehler einer Seite mit derselben Seite im letzten Scan Ihrer überwachten Website verglichen (über den Pfad, sodass eine Preview-URL ihr Live-Gegenstück findet), und nur die noch nicht vorhandenen zählen. Regeln, die Sie für die Website ignoriert haben, werden ebenfalls übersprungen. Die Website-IDs finden Sie im Tab API & CI des Dashboards oder über GET /api/v1/sites.

node equalvia-check.mjs "$URL/" "$URL/pricing" --fail-on serious --baseline SITE_ID

Gut zu wissen

• Die Seiten müssen aus dem Internet erreichbar sein, denn unsere Server laden sie. Für eine geschützte Preview nutzen Sie eine öffentliche Staging-URL oder die Bypass-Option Ihres Hosters (bei Vercel den Query-Parameter für Protection Bypass; die URL wird mit der Prüfung gespeichert).
• Jede URL einer Prüfung verbraucht eine Seite des Monatskontingents, unabhängig vom Ergebnis. Das Kontingent beginnt zu jedem Monatsanfang (UTC) neu.
• Eine Seite, die nicht lädt, mit einem Fehlerstatus antwortet oder auf eine Fehlerseite umleitet, lässt die Prüfung fehlschlagen: Ein kaputtes Deployment soll nie bestehen.
• Prüfungen sind von der Überwachung getrennt: Sie ändern weder Berichte noch Verlauf noch E-Mail-Zusammenfassungen Ihrer Websites.
• Automatische Tests finden einen großen Teil der Barrieren, aber nicht alle. Behalten Sie die angeleiteten manuellen Prüfungen in Ihrem Release-Ablauf.