GitHub Action

Fang opp tilgjengelighetsregresjoner før du slår sammen

Kjør wcagc mot forhåndsvisnings-URL-er for pull requests, publiser en lesbar jobboppsummering og la sjekken feile bare etter den policyen teamet ditt velger.

Opprett en CI API-nøkkel

Legg til ett trinn i arbeidsflyten

Lagre en ci:check-nøkkel som WCAGC_API_KEY, list opp inntil 5 URL-er på Free eller 20 på betalte abonnementer fra ett verifisert nettsted, og velg terskelen som skal blokkere en sammenslåing.

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 med gratis CI-sjekker

Free-organisasjoner får 30 CI-sjekker hver måned. Hver sjekk kan dekke inntil 5 URL-er fra ett verifisert domene. Skriv ut SARIF-filen i arbeidsflyten og last den opp i et eget GitHub-trinn når du trenger varige resultater i kodeskanningen.

Se oppføringen i 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

Velg policyen som passer til utgivelsen

Action rapporterer alltid alle automatiske funn. Innstillingen fail-on styrer bare CI-avgjørelsen.

new-critical
Feiler bare når et kritisk funn er nytt sammenlignet med den siste vellykkede baselinen. Uten baseline faller den trygt tilbake til any-critical.
any-critical
Feiler når en sjekket side har minst ett kritisk funn.
serious-or-worse
Feiler når det finnes et kritisk eller alvorlig funn.
none
Rapporter funn uten å la arbeidsflyten feile.

En baseline er dokumentasjon, ikke et unntak

Tjenesten sammenligner kombinasjoner av regel og side med den siste vellykkede CI-sjekken for samme nettsted. Eksisterende funn forblir synlige, bare antallet nye endres. Hvis baseline mangler, bruker new-critical den strengere policyen any-critical.

Opprett GitHub Issues fra funn

Koble til ett repository, eksporter teknisk dokumentasjon og la wcagc lukke eller gjenåpne saken etter hvert som utbedringen endrer seg.

Koble til GitHub Issues

En sjekk utviklere kan lese

Eksempel på wcagc CI-oppsummering av funn
Alvorlighetsgrad	Funn	Nye
Critical	1	0
Serious	3	1

Jobboppsummeringen lenker til hele rapporten og legger til et begrenset antall merknader uten å oversvømme pull requesten.