Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
shield

GitHub Action

Web Accessibility Evaluation

v1.7.1

Web Accessibility Evaluation

shield

Web Accessibility Evaluation

Fast and feature-packed web accessibility testing

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Web Accessibility Evaluation

              
  uses: a11ywatch/[email protected]
Learn more about this action in a11ywatch/github-actions

Choose a version

a11ywatch-github-action

A11yWatchBot

A GitHub action that runs accessibility and vitals test on your website that goes beyond what a linter can catch. The reports give detailed insight on WCAG2.1+ including other web accessibility issues with accurate descriptions for missing alts (machine learning and AI), color contrast, and much more. This action installs the A11yWatch CLI onto your pipeline starting the suite locally or from a remote external connection.

Usage

- uses: a11ywatch/[email protected]
  with:
    WEBSITE_URL: ${{ secrets.WEBSITE_URL }}
    SUBDOMAINS: true
    TLD: true
    FAIL_ERRORS_COUNT: 10
    COMPUTER_VISION_SUBSCRIPTION_KEY: ${{ secrets.COMPUTER_VISION_SUBSCRIPTION_KEY }}
    COMPUTER_VISION_ENDPOINT: ${{ secrets.COMPUTER_VISION_SUBSCRIPTION_KEY }}

Action inputs

All inputs are optional except $WEBSITE_URL.

Name Description Default
WEBSITE_URL Website domain to scan (Start with http:// or https://).
SITE_WIDE Site-wide scanning across all pages. false
SUBDOMAINS Include all subdomains (required SITE_WIDE=true). true
TLD Include all tld extensions (required SITE_WIDE=true). true
FAIL_TOTAL_COUNT Determine whether to fail the CI if total issues warnings and errors exceed the counter. Takes precedence over the other FAIL inputs. 0
FAIL_ERRORS_COUNT Determine whether to fail the CI if total issues with errors exceed the counter. 0
FAIL_WARNINGS_COUNT Determine whether to fail the CI if total issues with warnings exceed the counter. 0
EXTERNAL Use the A11yWatch remote api for fast results. If this is set A11YWATCH_TOKEN is needed.
COMPUTER_VISION_SUBSCRIPTION_KEY Computer Vision API key for image recognition on alts.
COMPUTER_VISION_ENDPOINT Computer Vision url endpoint. false
DISABLE_PR_STATS Prevent messaging to the pr results of test. false
TOKEN GITHUB_TOKEN (permissions contents: write and pull-requests: write) or a repo scoped Personal Access Token (PAT). GITHUB_TOKEN
A11YWATCH_TOKEN The A11yWatch api token to use to identify a user.

Action Outputs

Name Description Default
results The results of the report as json.
issues The amount of issues found

An example based on the above reference configuration creates a comment on pull requests that look like this:

Example of action results posting to Github