search

beeminder / blog

3 stars 2 forks source link

Add accessibility CI check #500

Open narthur opened 3 weeks ago

narthur commented 3 weeks ago

Luke and I built a GitHub action called pa11y-ratchet to provide an easy way to include slick accessibility checks on PRs.

The action creates and updates a single comment on every PR listing all accessibility issues discovered by the scan:

Screenshot 2024-06-04 at 9 21 31 AM

In addition the table indicates how many instances the current PR introduces, fixes, or retains, and also lists the number of instances ignored if certain issue types have been ignored in the action's inputs.

Additionally, the action adds a full, detailed summary to the job run, accessible via the full summary link in the PR comment:

Screenshot 2024-06-04 at 9 23 50 AM

The action only fails if a new, non-ignored issue is added by the current PR, meaning it won't block dev work if there is a backlog of issues that need addressed, while still insuring that new accessibility issues are not introduced.

I propose that we add a CI check to this repo that uses pa11y-ratchet to scan for accessibility issues on every PR.

narthur commented 3 weeks ago

I additionally propose that we actually do this by creating two checks, one that checks for issues in everything but etherpad content, and one that checks for issues only in etherpad content.