accessibility-insights-action icon indicating copy to clipboard operation
accessibility-insights-action copied to clipboard

Github Action to scan for accessibility issues in github pages

Product Logo Accessibility Insights Action

Actions Status codecov

This action is still in early development & we don't recommend its usage in public production projects yet.

About

The Accessibility Insights Action helps integrate automated accessibility tests in your GitHub workflow and Azure pipeline. It can be configured to scan a single page or also crawl and scan pages accessed from links on the given page. This can work for static files in your repository or remote URLs. The Accessibility Insights Action uses the axe-core rules engine to scan websites and web apps for common accessibility issues.

Automated checks can detect some common accessibility problems such as missing or invalid properties. But most accessibility problems can only be discovered through manual testing. The best way to evaluate web accessibility compliance is to complete an assessment using Accessibility Insights for Web.

For more information, see How to use the GitHub Action.

Contributing

To build and test, see developer docs.

See CONTRIBUTING.md for more info about the contributor license agreement.