pattonwebz/Axe Scan
Scan a set of URLs with axe-core using the runner's preinstalled Chrome and save the raw results as JSON.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| urls | URLs to scan, as JSON: an array of URL strings, or an object like {"urls": ["https://example.com/"]}. | no | "" |
| urls-file | Path to a file containing one URL per line. Useful when a site build step generates the list. Merged with `urls` if both are set. | no | "" |
| tags | Comma-separated axe rule tags to limit the scan (e.g. wcag2a,wcag2aa). Empty runs the full default ruleset. Cannot be combined with rules. | no | "" |
| rules | Rule IDs to run exclusively, as JSON: an array of strings or {"rules": [...]}. Use with configure-file to run just a custom ruleset. Cannot be combined with tags. | no | "" |
| configure-file | Path to an axe.configure() payload injected into each page after axe-core: a .json file containing a configure spec, or a .js file (plain browser script, e.g. a bundled ruleset package) that calls axe.configure() itself. | no | "" |
| scan-error-pages | Set to true to scan pages that respond with a non-2xx HTTP status (e.g. to audit a 404 template). Default false: error responses are recorded as scan failures. | no | false |
| fail-on | Minimum violation impact that fails this step: critical, serious, moderate, minor, or none. Default none — the scan only records results and leaves pass/fail to a downstream step (e.g. axe-report-action). | no | none |
| output-file | Path to write the raw JSON results to. | no | axe-results.json |
Outputs
| name | description |
|---|---|
| results-file | Path to the raw JSON results file (feed this to axe-report-action). |
| total-violations | Total number of violations (counted per affected element) across all URLs. |
| failed-urls | Number of URLs that could not be scanned or, when fail-on is set, had violations at/above that level. |