Skip to content

README.md

Latest commit

 

History

History
43 lines (33 loc) · 4.36 KB

README.md

File metadata and controls

43 lines (33 loc) · 4.36 KB
Raw

axe-devhub-action

A GitHub Action that fetches accessibility results from Axe Developer Hub for a given commit and integrates them into your pull request workflow. Your test suite must already be instrumented with Axe Watcher and have uploaded results for the current commit before this action runs. See https://docs.deque.com/developer-hub/2/en/dh-github-action for more setup information.

Permissions

The action comments on the pull request associated with the commit, so the calling job needs a token that can write to pull requests:

permissions:
  contents: read         # only if the job also runs actions/checkout
  pull-requests: write   # add, update and hide the accessibility comment

Note that declaring a permissions block sets every scope you do not list to none, so include contents: read if the job checks out your repository.

Commenting is best effort. If the token cannot write — most commonly on a pull request from a fork, where GITHUB_TOKEN is always read-only — the action logs a warning and carries on; the accessibility result itself is unaffected.

Inputs

name description required default
api_key Your Axe Developer Hub API key ✅
project_id The ID of your Axe Developer Hub project ❌ Required for newer projects after December 9, 2025. Legacy projects will continue to work
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
commit_sha Override the commit SHA to check status for ❌ github.sha

Outputs

name description
project Project name
project_id Project ID
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