zachkklein/a11yGuard

Detect accessibility regressions between your PR and main

Trust Signals

name	description	required	default
OPENROUTER_API_KEY	API Key for OpenRouter (required for AI fixes)	no	""
APP_DIR	Path to your app directory relative to the repo root (e.g. "my-app", "frontend", or "." for root).	no	.
BUILD_DIR	The static build output directory name (e.g. "out", "dist", "build").	no	dist
BUILD_COMMAND	The npm script used to build your app.	no	build
URLS	Comma-separated list of URL paths to scan (e.g. "/,/about,/dashboard").	no	/
IGNORE_RULES	Comma-separated list of axe rule IDs to ignore (e.g. "color-contrast,duplicate-id").	no	""
FAIL_ON_REGRESSION	Fail the check if new violations are introduced. Set to "false" to report only.	no	true
IMPACT_LEVEL	Minimum impact level to track. One of: minor, moderate, serious, critical.	no	moderate
WAIT_FOR_NETWORK_IDLE	Wait for network idle before scanning each page. Recommended for SPAs.	no	true
EXTRA_WAIT_MS	Additional wait time in milliseconds after page load before scanning.	no	500
TOKEN	GitHub token with pull-requests: write permission.	no	${{ github.token }}
BASE_URL	Base branch deployment URL (e.g. production or main preview). If set with PR_URL, skips local build/serve.	no	""
PR_URL	PR preview deployment URL (e.g. Vercel PR comment link). If set with BASE_URL, skips local build/serve.	no	""

name	description
new_violations	Number of new violations introduced by this PR.
resolved_violations	Number of violations resolved by this PR.
regression	Whether a regression was detected ("true" or "false").