A GitHub Action for reporting the axe DevHub status of a particular commit.
A full example of the axe-devhub-action
can be seen at .github/workflows/tests.yml
.
name | description | required | default |
---|---|---|---|
api_key |
Your axe Watcher API key | ✅ | |
server_url |
Axe server URL | ❌ | https://axe.deque.com |
retry_count |
Number of times to retry | ❌ | 10 |
github_token |
Optional PAT | ❌ | secrets.GITHUB_TOKEN |
enable_a11y_threshold |
Enable the a11y threshold, which will cause the action to fail if the number of violations is greater than the threshold | ❌ | false |
name | description |
---|---|
project |
Project associated with your API key |
axe_url |
URL for viewing axe issues detected on your commit |
issue_count |
Number of axe issues detected |
created_at |
DateTime when run occurred |
resolved_issues |
Number of axe issues resolved |
difference_in_page_states |
Difference in number of page states detected |
page_states |
Number of page states detected |
issues_over_a11y_threshold |
Number of issues over a11y threshold |