GitHub Action

Havaitse saavutettavuusregressiot ennen yhdistämistä

Aja wcagc pull requestien esikatseluosoitteita vasten, julkaise luettava työn yhteenveto ja anna tarkistuksen epäonnistua vain tiimisi valitseman käytännön mukaan.

Luo CI API -avain

Lisää yksi työnkulun vaihe

Tallenna ci:check-avain nimellä WCAGC_API_KEY, listaa enintään 5 URL-osoitetta Free-tilauksessa tai 20 maksullisissa tilauksissa yhdeltä vahvistetulta sivustolta ja valitse kynnys, joka estää yhdistämisen.

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

Aloita ilmaiset CI-tarkistukset

Free-organisaatiot saavat 30 CI-tarkistusta kuukaudessa. Kukin tarkistus voi kattaa enintään 5 URL-osoitetta yhdeltä vahvistetulta verkkotunnukselta. Kirjoita SARIF työnkulussa ja lataa se erillisessä GitHub-vaiheessa, kun tarvitset pysyviä koodiskannauksen tuloksia.

Näytä GitHub Marketplace -listaus

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

Valitse julkaisuun sopiva käytäntö

Action raportoi aina kaikki automaattiset havainnot. Asetus fail-on ohjaa vain CI:n lopputulosta.

new-critical
Epäonnistuu vain, kun kriittinen havainto on uusi verrattuna viimeisimpään onnistuneeseen perustasoon. Jos perustasoa ei ole, se palaa turvallisesti käytäntöön any-critical.
any-critical
Epäonnistuu, kun jokin tarkistettu sivu sisältää vähintään yhden kriittisen havainnon.
serious-or-worse
Epäonnistuu, kun jokin kriittinen tai vakava havainto on olemassa.
none
Raportoi havainnot ilman, että työnkulku epäonnistuu.

Perustaso on todiste, ei vapautus

Palvelu vertaa sääntö–sivu-pareja saman sivuston viimeisimpään onnistuneeseen CI-tarkistukseen. Olemassa olevat havainnot pysyvät näkyvissä, vain uusien määrä muuttuu. Jos perustaso puuttuu, new-critical käyttää tiukempaa any-critical-käytäntöä.

Luo GitHub Issues -tikettejä havainnoista

Yhdistä yksi repositorio, vie tekniset todisteet ja anna wcagc:n sulkea tai avata tiketti uudelleen korjaustilanteen muuttuessa.

Yhdistä GitHub Issues

Tarkistus, jonka kehittäjät voivat lukea

Esimerkki wcagc CI -havaintojen yhteenvedosta
Vakavuus	Havainnot	Uudet
Critical	1	0
Serious	3	1

Työn yhteenveto linkittää täyteen raporttiin ja lisää rajattuja huomautuksia täyttämättä pull requestia.