Skip to content

Commit b576c16

Browse files
authored
chore: Merge #1911 into v1 (#2176)
This PR merges github-community-projects/continuous-ai-for-accessibility-scanner#1911 into the `v1` branch.
2 parents ba75365 + 122c127 commit b576c16

File tree

1 file changed

+28
-23
lines changed

1 file changed

+28
-23
lines changed

README.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ The a11y scanner helps teams:
1212
1313
---
1414

15+
## Requirements
16+
17+
This project is a GitHub Actions action. A GitHub Actions workflow is required to run it, and you must have available GitHub Actions minutes.
18+
19+
📚 [Understanding GitHub Actions](https://docs.github.com/en/actions/get-started/understand-github-actions) | [Quickstart for GitHub Actions](https://docs.github.com/en/actions/get-started/quickstart) | [Writing workflows](https://docs.github.com/en/actions/how-tos/write-workflows) | [GitHub Actions billing](https://docs.github.com/en/billing/concepts/product-billing/github-actions)
1520
## Getting Started
1621

1722
### 1. Add a Workflow File
@@ -26,23 +31,13 @@ jobs:
2631
accessibility_scanner:
2732
runs-on: ubuntu-latest
2833
steps:
29-
# Retrieve the scanner code
30-
- uses: actions/checkout@v5
31-
with:
32-
repository: github-community-projects/continuous-ai-for-accessibility-scanner
33-
ref: v1
34-
token: ${{ secrets.GH_COMMUNITY_PROJECTS_TOKEN }} # This token must have read access to github-community-projects/continuous-ai-for-accessibility-scanner; more information below.
35-
path: ./.github/actions/continuous-ai-for-accessibility-scanner
36-
# Prepare the scanner to run
37-
- shell: bash
38-
run: cp -Rf ./.github/actions/continuous-ai-for-accessibility-scanner/.github/actions/* ./.github/actions
39-
# Run the scanner
40-
- uses: ./.github/actions/continuous-ai-for-accessibility-scanner
34+
- uses: github-community-projects/continuous-ai-for-accessibility-scanner@v1
4135
with:
4236
urls: | # Provide a newline-delimited list of URLs to scan; more information below.
4337
REPLACE_THIS
4438
repository: REPLACE_THIS/REPLACE_THIS # Provide a repository name-with-owner (in the format "primer/primer-docs"). This is where issues will be filed and where Copilot will open PRs; more information below.
4539
token: ${{ secrets.GH_TOKEN }} # This token must have write access to the repo above (contents, issues, and PRs); more information below. Note: GitHub Actions’ `GITHUB_TOKEN` (https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) cannot be used here.
40+
cache_key: REPLACE_THIS # Provide a filename that will be used when caching results. We recommend including the name or domain of the site being scanning.
4641
```
4742
4843
> 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.
@@ -56,15 +51,9 @@ Required Permissions:
5651

5752
---
5853

59-
### 2. Create Tokens and Add Secrets
60-
61-
The a11y scanner requires two Personal Access Tokens (PATs) as repository secrets:
54+
### 2. Create a Token and Add a Secret
6255

63-
#### The `GH_COMMUNITY_PROJECTS_TOKEN` is a fine-grained PAT with
64-
65-
- `contents: read`
66-
- `metadata: read`
67-
- Scope: [`github-community-projects/continuous-ai-for-accessibility-scanner`](https://github.com/github-community-projects/continuous-ai-for-accessibility-scanner)
56+
The a11y scanner requires a Personal Access Token (PAT) as repository secret:
6857

6958
#### The `GH_TOKEN` is a fine-grained PAT with
7059

@@ -73,7 +62,7 @@ The a11y scanner requires two Personal Access Tokens (PATs) as repository secret
7362
- `issues: write`
7463
- `pull-requests: write`
7564
- `metadata: read`
76-
- Scope: Your target repository (where issues and PRs will be created)
65+
- Scope: Your target repository (where issues and PRs will be created) and the repository containing your workflow
7766

7867
> 👉 GitHub Actions' default `GITHUB_TOKEN` cannot be used here.
7968

@@ -129,8 +118,24 @@ The a11y scanner leverages Copilot coding agent, which can be configured with cu
129118

130119
## Feedback
131120

132-
Beta participants have direct contact for questions and suggestions. A public feedback form will be available once the project is open-sourced.
121+
Please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file for more information.
122+
123+
## License
124+
125+
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
126+
127+
## Maintainers
128+
129+
Please refer to the [CODEOWNERS](./.github/CODEOWNERS) file for more information.
130+
131+
## Support
132+
133+
Please refer to the [SUPPORT](./SUPPORT.md) file for more information.
134+
135+
## Acknowledgement
136+
137+
Thank you to our beta testers for their help in testing this project.
133138

134139
---
135140

136-
*Last updated: 2025-10-01*
141+
*Last updated: 2025-10-09*

0 commit comments

Comments
 (0)