GitHub Action

Barrierefreiheitsregressionen vor dem Merge erkennen

Prüfen Sie Pull-Request-Preview-URLs mit wcagc, veröffentlichen Sie eine lesbare Zusammenfassung und lassen Sie CI nur nach der gewählten Richtlinie fehlschlagen.

CI-API-Schlüssel erstellen

Ein Schritt im Workflow

Speichern Sie einen ci:check-Schlüssel als WCAGC_API_KEY, listen Sie bis zu 5 URLs in Free oder 20 in bezahlten Tarifen einer verifizierten Website auf und wählen Sie die Blockierschwelle.

name: Accessibility check
on: [pull_request]

jobs:
  wcagc:
    runs-on: ubuntu-latest
    steps:
      - uses: WCAG-Compliance/wcagc-ci@v1
        with:
          api-key: ${{ secrets.WCAGC_API_KEY }}
          urls: |
            https://preview.example.com/
            https://preview.example.com/checkout
          fail-on: new-critical

Start free CI checks

Free organizations receive 30 CI checks each month. Each check can cover up to 5 URLs from one verified domain. Write SARIF in the workflow and upload it in a separate GitHub step when you need persistent code-scanning results.

View the GitHub Marketplace listing

permissions:
  contents: read
  security-events: write

steps:
  - uses: WCAG-Compliance/wcagc-ci@v1
    with:
      api-key: ${{ secrets.WCAGC_API_KEY }}
      urls: https://preview.example.com
      sarif-file: results/wcagc.sarif
  - uses: github/codeql-action/upload-sarif@v3
    if: always()
    with:
      sarif_file: results/wcagc.sarif

Passende Richtlinie für den Release wählen

Die Action meldet immer alle automatisierten Befunde. fail-on steuert nur das CI-Ergebnis.

new-critical
Nur bei einem neuen kritischen Befund gegenüber der letzten erfolgreichen Baseline fehlschlagen. Ohne Baseline gilt sicherheitshalber any-critical.
any-critical
Fehlschlagen, sobald eine geprüfte Seite einen kritischen Befund enthält.
serious-or-worse
Bei jedem kritischen oder schwerwiegenden Befund fehlschlagen.
none
Befunde melden, ohne den Workflow fehlschlagen zu lassen.

Eine Baseline ist ein Nachweis, kein Freibrief

Der Dienst vergleicht Regel-und-Seiten-Paare mit der letzten erfolgreichen CI-Prüfung derselben Website. Bestehende Befunde bleiben sichtbar; nur die Anzahl neuer Befunde ändert sich. Fehlt die Baseline, nutzt new-critical die strengere Richtlinie any-critical.

GitHub Issues aus Befunden erstellen

Verbinden Sie ein Repository, exportieren Sie technische Nachweise und lassen Sie wcagc das Issue schließen oder wieder öffnen.

GitHub Issues verbinden

Eine verständliche Prüfung für Entwickler

Beispiel einer wcagc CI-Befundübersicht
Schweregrad	Befunde	Neu
Critical	1	0
Serious	3	1

Die Job-Zusammenfassung verlinkt den vollständigen Bericht und begrenzt Annotationen, damit der Pull Request übersichtlich bleibt.