{"id":14482848,"url":"https://github.com/a11ywatch/github-actions","last_synced_at":"2025-04-19T17:19:02.063Z","repository":{"id":38008288,"uuid":"468039560","full_name":"a11ywatch/github-actions","owner":"a11ywatch","description":"A11yWatch Github Action","archived":false,"fork":false,"pushed_at":"2025-02-07T21:17:22.000Z","size":128,"stargazers_count":24,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T12:36:10.441Z","etag":null,"topics":["a11ywatch","accessibility","github-actions","web-accessibility","web-accessibility-tool"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/web-accessibility-evaluation","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/a11ywatch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["a11ywatch"]}},"created_at":"2022-03-09T18:04:41.000Z","updated_at":"2025-02-07T21:17:26.000Z","dependencies_parsed_at":"2023-09-27T23:14:21.146Z","dependency_job_id":"a7626667-87ef-407c-b71e-957746ba1d23","html_url":"https://github.com/a11ywatch/github-actions","commit_stats":{"total_commits":61,"total_committers":2,"mean_commits":30.5,"dds":"0.016393442622950838","last_synced_commit":"b6c4b69cda04e0abc6a215b37251b737de4f331e"},"previous_names":[],"tags_count":130,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a11ywatch%2Fgithub-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a11ywatch%2Fgithub-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a11ywatch%2Fgithub-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a11ywatch%2Fgithub-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a11ywatch","download_url":"https://codeload.github.com/a11ywatch/github-actions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249746659,"owners_count":21319663,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11ywatch","accessibility","github-actions","web-accessibility","web-accessibility-tool"],"created_at":"2024-09-03T00:01:19.737Z","updated_at":"2025-04-19T17:19:02.022Z","avatar_url":"https://github.com/a11ywatch.png","language":null,"funding_links":["https://github.com/sponsors/a11ywatch"],"categories":["Others"],"sub_categories":[],"readme":"# github-action\n\n[![Tests](https://github.com/a11ywatch/github-actions/actions/workflows/action.yml/badge.svg)](https://github.com/a11ywatch/github-actions/actions/workflows/action.yml)\n\nA feature rich GitHub action that runs actionable accessibility reports on your website that can handle large workloads.\n\nSome of the primary features include pass/fail testing, code fixes, and detailed reports.\n\nWhen running locally the action uses A11yWatch Lite and installs the [a11ywatch-cli](https://github.com/a11ywatch/a11ywatch).\n\n### Usage\n\n```yaml\n- uses: a11ywatch/github-action@v2.1.10\n with:\n WEBSITE_URL: ${{ secrets.WEBSITE_URL }}\n SITE_WIDE: true\n SUBDOMAINS: true\n TLD: false\n SITEMAP: true\n FAIL_ERRORS_COUNT: 15\n LIST: true\n FIX: false\n UPGRADE: false\n UPLOAD: true\n COMPUTER_VISION_SUBSCRIPTION_KEY: ${{ secrets.COMPUTER_VISION_SUBSCRIPTION_KEY }}\n COMPUTER_VISION_ENDPOINT: ${{ secrets.COMPUTER_VISION_ENDPOINT }}\n env:\n DEFAULT_RUNNERS: htmlcs,axe\n PAGEMIND_IGNORE_WARNINGS: true\n AI_DISABLED: false\n```\n\n### Action inputs\n\nAll inputs are **optional** except $WEBSITE_URL.\n\n| Name | Description | Default |\n| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |\n| `WEBSITE_URL` | Website domain to scan (Start with http:// or https://). | |\n| `SITE_WIDE` | Site-wide scanning across all pages. | false |\n| `FIX` | Attempt to apply recommendations to code and commit to github. | false |\n| `SUBDOMAINS` | Include all subdomains (required SITE_WIDE=true). | true |\n| `SITEMAP` | Extend crawl with sitemap links (required SITE_WIDE=true). | true |\n| `TLD` | Include all tld extensions (required SITE_WIDE=true). | true |\n| `LIST` | Report the results to github as a pass or fail list or detailed report. | false |\n| `RECORD` | Record the audit as video to a directory. | |\n| `FAIL_TOTAL_COUNT` | Determine whether to fail the CI if total issues warnings and errors exceed the counter. Takes precedence over the other FAIL inputs. Set to a value greater than 0 for CI failure. | 0 |\n| `FAIL_ERRORS_COUNT` | Determine whether to fail the CI if total issues with errors exceed the counter. Set to a value greater than 0 for CI failure. | 0 |\n| `FAIL_WARNINGS_COUNT` | Determine whether to fail the CI if total issues with warnings exceed the counter. Set to a value greater than 0 for CI failure. | 0 |\n| `EXTERNAL` | Use the A11yWatch remote API for fast results. If this is set `A11YWATCH_TOKEN` is needed. | |\n| `COMPUTER_VISION_SUBSCRIPTION_KEY` | [Computer Vision](https://azure.microsoft.com/en-us/services/cognitive-services/computer-vision/#overview) API key for image recognition on alts. | |\n| `COMPUTER_VISION_ENDPOINT` | Computer Vision url endpoint. | false |\n| `DISABLE_PR_STATS` | Prevent messaging to the pr results of test. | false |\n| `TOKEN` | `GITHUB_TOKEN` (permissions `contents: write` and `pull-requests: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |\n| `A11YWATCH_TOKEN` | The A11yWatch API token to use to identify a user. | |\n| `SLIM` | Use the gRPC client to gather reports - only displays stats, useful for large websites (no code generation, no outputs, just pure stats) | false |\n| `UPGRADE` | Upgrade the docker images before testing to latest. | false |\n| `UPLOAD` | Upload the data as an artifact to get better insight. | false |\n\n### Action Outputs\n\n| Name | Description | Default |\n| --------- | --------------------------------- | ------- |\n| `issues` | The amount of issues found. | |\n| `results` | The results of the audit as json. | |\n\n### ENV Variables\n\nConfigure crawl wide settings for A11yWatch Lite (local) installs.\n\n| Name | Description | Default |\n| -------------------------- | ----------------------------------------------------------------------------------------------------- | ------------ |\n| `DEFAULT_RUNNERS` | A comma separated list of runners to use in Litemode for testing like `axe` and `htmlcs`. | `htmlcs,axe` |\n| `PAGEMIND_IGNORE_WARNINGS` | Enable to ignore all warnings from output. This could speed up runs and save on audit size. | false |\n| `AI_DISABLED` | Disable AI use to get missing resource props like alts. If enabled the speed may increase of the run. | false |\n\nIf you set it to only `htmlcs` you will have really fast crawls with good coverage with our fork.\n\n## Performance\n\nOn a larger website A11yWatch action runs over 60x-10,000x+ faster depending on CPUs/hardware. After the first installation you should have faster setup time between runs.\nYou can expect to handle at least 1k pages per minute on a 2-core CPU 7 GB of RAM memory shared github action. If you enable `RECORD` the output time may increase a bit.\n\n## Common Issues\n\nIf you experience issues on your CI you may have to toggle the `UPGRADE` input to true in order to get the latest installs. If you see\na playwright error try adding `PLAYWRIGHT_VERSION` env variable with the newest version to install chrome.\n\n## LICENSE\n\ncheck the license file in the root of the project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa11ywatch%2Fgithub-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa11ywatch%2Fgithub-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa11ywatch%2Fgithub-actions/lists"}