https://github.com/mikaelvesavuori/a11ytester-action

Runs Webhint and pa11y (accessibility testing tools) on one or more provided URLs.
https://github.com/mikaelvesavuori/a11ytester-action

a11y accessibility accessibility-testing ci-cd code-quality quality testing

Last synced: about 1 month ago
JSON representation

Runs Webhint and pa11y (accessibility testing tools) on one or more provided URLs.

• Host: GitHub
• URL: https://github.com/mikaelvesavuori/a11ytester-action
• Owner: mikaelvesavuori
• License: mit
• Created: 2022-07-16T08:10:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-22T10:02:54.000Z (about 1 year ago)
• Last Synced: 2024-05-01T16:12:52.111Z (7 months ago)
• Topics: a11y, accessibility, accessibility-testing, ci-cd, code-quality, quality, testing
• Language: Shell
• Homepage: https://github.com/marketplace/actions/a11ytester-action
• Size: 13.7 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# `a11ytester-action`

Runs [Webhint](https://webhint.io) and [pa11y](https://pa11y.org) (accessibility testing tools) on one or more provided URLs. Results will be output into the logs of the action.

## Notices

This action is entirely dependent on tools running as intended in GitHub Actions (i.e. a CI platform), which is somewhat flaky, unfortunately.

This action _will currently not break_ when accessibility problems occur. The good side of this is that many typical sites will exhibit a fairly high ratio of "false positives" and similar.

Lastly, note that this action is a subset of the "full" [a11ytester](https://github.com/mikaelvesavuori/a11ytester) project, since GitHub Actions seems incapable of running Lighthouse.

## Required input arguments

### `urls`

One or more escaped URLs in the format (single) `'[\"www.google.com\"]'` or (multiple) `'[\"www.google.com\",\"www.reddit.com\"]'`.

## An example of how to use this action in a workflow

```yml

on: [push]

jobs:

  accessibility:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: a11ytester

        uses: mikaelvesavuori/a11ytester-action@v1

        with:

          urls: '[\"www.google.com\"]'

```

## Optional configurations for Webhint and Pa11y

Example configurations for the tools are below. These files should reside in the repository utilizing the action.

### `.hintrc`

```json

{

  "extends": ["accessibility", "web-recommended"],

  "formatters": ["json"],

  "connector": {

    "name": "puppeteer",

    "options": {

      "headless": true

    }

  }

}

```

### .pa11yci

```json

{

  "defaults": {

    "concurrency": 4,

    "standard": "WCAG2AA",

    "runners": ["axe"]

  }

}

```