Skip to content

booleans-oss/pa11y-actions

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

pa11y-actions

build-test status pa11y status

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@v1
- uses: browser-actions/setup-chrome@latest
- uses: Hesedi3l/pa11y-actions@v1
  with:
    start: start
    port: '3000'

browser-actions/setup-chrome@latest is needed for this action to work. Make sure you put the chrome Github Action before pa11y-actions.

Both port and start inputs are optional. If not supplied, the port would be set as '3000' and the running script would be set as 'start'.

The action will firstly installed your project dependencies. The web application will, then, be started with the script provided npm run start by default. Then, pa11y will analyse the resultant web app running on the port set ( by default: 3000). If results, the workflow will fail and print the results. If no result, the worklow passes.

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome!

Code of Conduct

👋 Be nice. See our code of conduct

About

Pa11y Actions to detect accessibility-related issues on a web app.

Resources

License

Stars

Watchers

Forks

Packages

No packages published