GitLab CI

Aja saavutettavuustarkistukset jokaisessa merge requestissa

Käytä samaa wcagc-tarkistussopimusta GitLab CI:ssä: testaa esikatseluosoitteet, vertaa havaintoja perustasoon ja tee putken lopputuloksesta selkeä.

Luo API-avain

Lisää putken malli

Tallenna API-avain ja kohde-URL:t CI/CD-muuttujiksi ja lisää sitten uudelleenkäytettävät työt. Merge requestit vain vertaavat, oletushaara omistaa perustason päivitykset.

.wcagc-check:
  image: node:24-alpine
  script:
    - npx --yes github:WCAG-Compliance/wcagc-ci#v1

wcagc-merge-request:
  extends: .wcagc-check
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'

wcagc-default-branch-baseline:
  extends: .wcagc-check
  variables:
    WCAGC_FAIL_ON: none
    WCAGC_SET_BASELINE: "true"
  rules:
    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

Määritä CI/CD-muuttujat

Pidä määritykset selkeinä ja tunnistetiedot poissa repositoriosta.

  • WCAGC_API_KEY

    Pakollinen peitetty salaisuus, jolla on vain ci:check-oikeusalue. Älä paljasta sitä epäluotettavien forkkien putkille.

  • WCAGC_URLS

    Pakollinen rivinvaihdoilla tai pilkuilla erotettu lista rekisteröityjä URL-osoitteita, enintään 20 URL-osoitetta tarkistusta kohti.

  • WCAGC_FAIL_ON

    Käytä oletuksena new-critical tai valitse any-critical, serious-or-worse tai none.

  • WCAGC_SET_BASELINE

    Aseta true vain suojatun oletushaaran työssä, jotta tarkistusputket eivät voi kirjoittaa vertailupistettä uudelleen.

Pidä merge request -putkia luottamusrajana

GitLabin suojatut muuttujat ovat käytettävissä vain kelvollisille suojatuille viitteille, ellet nimenomaisesti löysää käytäntöä. Tarkista forkki- ja suojattujen muuttujien asetukset ennen ulkopuolisten muutosten ajamista.

Selkeä tuloste ja ennustettavat poistumiskoodit

CLI tulostaa vakavuusmäärät, uudet havainnot, raporttilinkin ja automaation kattavuusrajoituksen. PASS poistuu koodilla 0, epäonnistunut tarkistus tai ajovirhe koodilla 1 ja virheellinen määritys koodilla 2.