Skip to content

GITHUB_ACCESSIBILITY_SCANNER_INTEGRATION.md

Latest commit

 

History

History
73 lines (50 loc) · 2.79 KB

GITHUB_ACCESSIBILITY_SCANNER_INTEGRATION.md

File metadata and controls

73 lines (50 loc) · 2.79 KB
title GitHub Accessibility Scanner Integration

GitHub Accessibility Scanner Integration

This guide shows how to integrate GitHub's AI-powered Accessibility Scanner into your repository as part of your ACCESSIBILITY.md guardrails.

Why include this

  • Adds recurring and on-demand accessibility scans in GitHub Actions.
  • Creates trackable issues for discovered barriers.
  • Supports AI-assisted remediation workflows.

Recommended baseline workflow

Use the official action:

  • github/accessibility-scanner@v2

Typical setup:

  1. Run on a schedule (for continuous monitoring).
  2. Optionally run on workflow_dispatch for manual scans.
  3. Configure target URL, auth details (if needed), and repository token secret.
  4. Route findings into issues with your accessibility labels/taxonomy.

Governance requirements

  • Define severity handling in ACCESSIBILITY.md (Critical/High/Medium/Low).
  • Require triage of scanner-created issues within your SLA window.
  • Track scanner findings in your living metrics table.

Authentication notes

  • The scanner requires a token with appropriate repository permissions.
  • The default GITHUB_TOKEN is not sufficient for this action's issue/PR workflows.
  • For authenticated scans, support login flows or provide persisted auth context.

Suggested policy statement

Add language like this to your project manifest:

We run github/accessibility-scanner on a recurring schedule and treat scanner findings as first-class accessibility defects. New high-severity regressions block release until resolved or explicitly waived.

Connecting scanner findings to the remediation agent

After setting up the scanner, close the detect → fix loop by adding the complementary remediation workflow:

  1. Copy examples/AGENT_REMEDIATION_WORKFLOW.yml to .github/workflows/accessibility-remediation.yml.
  2. When the scanner creates an issue labelled accessibility, the remediation workflow fires automatically and passes the issue details to a Copilot coding agent.
  3. The agent locates the offending code, applies a minimal fix, and opens a draft pull request linked to the original issue.
  4. A human reviews and merges the draft PR.

Requires a GitHub Copilot Individual, Business, or Enterprise subscription with the Copilot coding agent feature enabled and the repository setting Settings → Copilot → "Allow Copilot to create and approve pull requests" enabled.

See examples/COPILOT_REMEDIATION_AGENT_PROMPT.md for the full structured agent task descriptions covering six common violation types (image-alt, label, link-name, heading-order, color-contrast, aria-required-attr).

Source