GitHub Action

Fånga tillgänglighetsregressioner innan du mergar

Kör wcagc mot förhandsvisnings-URL:er för pull requests, publicera en läsbar jobbsammanfattning och låt kontrollen endast fallera enligt den policy som ditt team väljer.

Skapa en API-nyckel för CI

Lägg till ett steg i arbetsflödet

Spara en ci:check-nyckel som WCAGC_API_KEY, ange upp till 5 URL:er på Free eller 20 på betalda planer från en verifierad webbplats och välj den tröskel som ska blockera en merge.

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

Kom igång med gratis CI-kontroller

Organisationer på Free får 30 CI-kontroller per månad. Varje kontroll kan omfatta upp till 5 URL:er från en verifierad domän. Generera en SARIF-fil i arbetsflödet och ladda upp den i ett separat GitHub-steg när du behöver beständiga code scanning-resultat.

Visa sidan på GitHub Marketplace
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

Välj den policy som passar releasen

Action rapporterar alltid alla automatiska fynd. Inställningen fail-on styr bara CI-utfallet.

  • new-critical

    Fallerar bara när ett kritiskt fynd är nytt jämfört med den senaste lyckade baslinjen. Utan baslinje faller den säkert tillbaka till any-critical.

  • any-critical

    Fallerar när någon kontrollerad sida har minst ett kritiskt fynd.

  • serious-or-worse

    Fallerar när något kritiskt eller allvarligt fynd finns.

  • none

    Rapporterar fynd utan att arbetsflödet fallerar.

En baslinje är belägg, inte ett undantag

Tjänsten jämför regel- och sidpar med den senaste lyckade CI-kontrollen för samma webbplats. Befintliga fynd förblir synliga; bara antalet nya ändras. Saknas baslinje använder new-critical den striktare policyn any-critical.

Skapa GitHub Issues från fynd

Anslut ett repository, exportera tekniska belägg och låt wcagc stänga eller öppna ärendet igen när åtgärderna ändras.

Anslut GitHub Issues

En kontroll som utvecklare kan läsa

Exempel på sammanfattning av CI-fynd i wcagc
AllvarlighetsgradFyndNya
Critical10
Serious31

Jobbsammanfattningen länkar till hela rapporten och lägger till ett begränsat antal annoteringar utan att översvämma pull requesten.