Releases: a11ywatch/github-actions
API Authentication
Add API authentication by setting the input A11YWATCH_TOKEN
to your authentication token from A11yWatch.
This is used to identify the user on endpoints that really on auth to get the data. Can be used local or remote to auth with the a11ywatch server.
Full Changelog: v1.2.21...v1.2.43
PR report integration
- Add comments using the A11yWatch bot to send a message to your PR that an issue occurred.
To disable send results to the PR set the flag DISABLE_PR_STATS
true.
name: Run accessibility test across your website.
on: [push, pull]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: A11yWatch Scan
uses: a11ywatch/[email protected]
id: a11ywatch-results-generator
with:
WEBSITE_URL: ${{ secrets.WEBSITE_URL }}
TOKEN: ${{ secrets.GITHUB_TOKEN }}
EXTERNAL: false
FAIL_ERROR_COUNT: 10
CI pass/fail option on issues
Add CI options to pass fail on issues.
New output var to use issues
which determines the amount of problems found that are in the error/warning category.
To come pass fail splitting between warning threshold against errors.
-- example
steps:
- uses: actions/checkout@v2
- name: A11yWatch
id: a11ywatch-results-generator
uses: A11yWatch/[email protected]
with:
WEBSITE_URL: ${{ secrets.WEBSITE_URL }}
FAIL_ERROR_COUNT: 10
EXTERNAL: true
- name: Get Results
run: |
echo "website accessibility issues count ${{ steps['a11ywatch-results-generator'].outputs.issues }}"
Full Changelog: v1.0.11...v1.1.1
External Usage
Add optional use the A11yWatch hosted infrastructure to get quick results. ( Subjected to rate limits ).
Atm returns only json, so the var needs to be parsed with fromJson
-- example
name: CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: A11yWatch
uses: A11yWatch/[email protected]
with:
WEBSITE_URL: ${{ secrets.WEBSITE_URL }}
EXTERNAL: true
- name: Get Scan Results
run: echo "website accessibility score ${{ fromJson(steps.a11ywatch-results-generator.outputs.results).website.adaScore }}"
To see the full json object echo ${{ toJSON(steps['a11ywatch-results-generator'].outputs.results) }} | jq ". | tojson"
v1.0.7
chore(action): add external input
Minor Startup Changes
Fix container startup detection docker log
Initial release
v1.0.0 chore(gh): add action bot