From c2624690c044733d13c115e95c451b959fcfa7f0 Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Fri, 10 Oct 2025 19:59:52 -0400 Subject: [PATCH 01/12] fix: Replace relative paths in 'uses' --- .github/actions/gh-cache/cache/action.yml | 4 ++-- .github/workflows/test.yml | 4 ++-- action.yml | 12 ++++++------ 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/actions/gh-cache/cache/action.yml b/.github/actions/gh-cache/cache/action.yml index f0c36a25..1bb9c9b9 100644 --- a/.github/actions/gh-cache/cache/action.yml +++ b/.github/actions/gh-cache/cache/action.yml @@ -25,7 +25,7 @@ runs: using: "composite" steps: - name: Restore cached value - uses: ./.github/actions/gh-cache/restore + uses: github/accessibility-scanner/.github/actions/gh-cache/restore@v2 with: path: ${{ inputs.key }} token: ${{ inputs.token }} @@ -41,7 +41,7 @@ runs: - if: ${{ inputs.value }} name: Save cached value - uses: ./.github/actions/gh-cache/save + uses: github/accessibility-scanner/.github/actions/gh-cache/save@v2 with: path: ${{ inputs.key }} token: ${{ inputs.token }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a78e07a8..ff6486fe 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -79,7 +79,7 @@ jobs: cache_key: ${{ steps.cache_key.outputs.cache_key }} - name: Retrieve cached results - uses: ./.github/actions/gh-cache/restore + uses: github/accessibility-scanner/.github/actions/gh-cache/restore@v2 with: path: ${{ steps.cache_key.outputs.cache_key }} token: ${{ secrets.GITHUB_TOKEN }} @@ -122,7 +122,7 @@ jobs: - name: Clean up cached results if: ${{ always() }} - uses: ./.github/actions/gh-cache/delete + uses: github/accessibility-scanner/.github/actions/gh-cache/delete@v2 with: path: ${{ steps.cache_key.outputs.cache_key }} token: ${{ secrets.GITHUB_TOKEN }} diff --git a/action.yml b/action.yml index d6bdb302..40c23607 100644 --- a/action.yml +++ b/action.yml @@ -41,7 +41,7 @@ runs: steps: - name: Restore cached results id: restore - uses: ./.github/actions/gh-cache/cache + uses: github/accessibility-scanner/.github/actions/gh-cache/cache@v2 with: key: ${{ inputs.cache_key }} token: ${{ inputs.token }} @@ -58,20 +58,20 @@ runs: - if: ${{ inputs.login_url && inputs.username && inputs.password && !inputs.auth_context }} name: Authenticate id: auth - uses: ./.github/actions/auth + uses: github/accessibility-scanner/.github/actions/auth@v2 with: login_url: ${{ inputs.login_url }} username: ${{ inputs.username }} password: ${{ inputs.password }} - name: Find id: find - uses: ./.github/actions/find + uses: github/accessibility-scanner/.github/actions/find@v2 with: urls: ${{ inputs.urls }} auth_context: ${{ inputs.auth_context || steps.auth.outputs.auth_context }} - name: File id: file - uses: ./.github/actions/file + uses: github/accessibility-scanner/.github/actions/file@v2 with: findings: ${{ steps.find.outputs.findings }} repository: ${{ inputs.repository }} @@ -88,7 +88,7 @@ runs: - if: ${{ inputs.skip_copilot_assignment != 'true' }} name: Fix id: fix - uses: ./.github/actions/fix + uses: github/accessibility-scanner/.github/actions/fix@v2 with: issues: ${{ steps.get_issues_from_filings.outputs.issues }} repository: ${{ inputs.repository }} @@ -118,7 +118,7 @@ runs: FILINGS: ${{ steps.file.outputs.filings }} FIXINGS: ${{ steps.fix.outputs.fixings }} - name: Save cached results - uses: ./.github/actions/gh-cache/cache + uses: github/accessibility-scanner/.github/actions/gh-cache/cache@v2 with: key: ${{ inputs.cache_key }} value: ${{ steps.results.outputs.results }} From 8c50adc01229031db883b50f23f79af4b9186a31 Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Sun, 12 Oct 2025 14:50:41 -0400 Subject: [PATCH 02/12] fix: Fix escaping and parsing issues in the v1-to-v2 cache migration step --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 40c23607..86472cf2 100644 --- a/action.yml +++ b/action.yml @@ -54,7 +54,7 @@ runs: # If cached data is a list of Finding objects, each with 'issueUrl' keys (i.e. v1), # convert to a list of (partial) Result objects, each with 'findings' and 'issue' keys (i.e. v2). # Otherwise, re-output as-is. - echo "value=$(echo '${{ steps.restore.outputs.value }}' | jq 'if (type == "array" and length > 0 and .[0] | has("issueUrl")) then map({findings: [del(.issueUrl)], issue: {url: .issueUrl}}) else . end' )" >> $GITHUB_OUTPUT + echo "value=$(printf '%s' '${{ steps.restore.outputs.value }}' | jq 'if (type == "array" and length > 0 and (.[0] | has("issueUrl"))) then map({findings: [del(.issueUrl)], issue: {url: .issueUrl}}) else . end' )" >> $GITHUB_OUTPUT - if: ${{ inputs.login_url && inputs.username && inputs.password && !inputs.auth_context }} name: Authenticate id: auth From 0a808b418aaee1958afb3ceaf40b310ab80f1aab Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Sun, 12 Oct 2025 15:27:37 -0400 Subject: [PATCH 03/12] fix: Output compact (one-line) JSON --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 86472cf2..35eeab24 100644 --- a/action.yml +++ b/action.yml @@ -54,7 +54,7 @@ runs: # If cached data is a list of Finding objects, each with 'issueUrl' keys (i.e. v1), # convert to a list of (partial) Result objects, each with 'findings' and 'issue' keys (i.e. v2). # Otherwise, re-output as-is. - echo "value=$(printf '%s' '${{ steps.restore.outputs.value }}' | jq 'if (type == "array" and length > 0 and (.[0] | has("issueUrl"))) then map({findings: [del(.issueUrl)], issue: {url: .issueUrl}}) else . end' )" >> $GITHUB_OUTPUT + printf '%s' "value=$(printf '%s' '${{ steps.restore.outputs.value }}' | jq -c 'if (type == "array" and length > 0 and (.[0] | has("issueUrl"))) then map({findings: [del(.issueUrl)], issue: {url: .issueUrl}}) else . end' )" >> $GITHUB_OUTPUT - if: ${{ inputs.login_url && inputs.username && inputs.password && !inputs.auth_context }} name: Authenticate id: auth From b7ef083b00f550da76d77cea98885ba3592d3837 Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Mon, 13 Oct 2025 11:03:57 -0400 Subject: [PATCH 04/12] fix: Read the 'cached_filings' input, not 'cached_results' --- .github/actions/file/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/actions/file/src/index.ts b/.github/actions/file/src/index.ts index fc108116..0c1304b3 100644 --- a/.github/actions/file/src/index.ts +++ b/.github/actions/file/src/index.ts @@ -21,7 +21,7 @@ export default async function () { const repoWithOwner = core.getInput("repository", { required: true }); const token = core.getInput("token", { required: true }); const cachedFilings: (ResolvedFiling | RepeatedFiling)[] = JSON.parse( - core.getInput("cached_results", { required: false }) || "[]" + core.getInput("cached_filings", { required: false }) || "[]" ); core.debug(`Input: 'findings: ${JSON.stringify(findings)}'`); core.debug(`Input: 'repository: ${repoWithOwner}'`); From a45e319705aa5690086cbee80efa8ef06f4ba30d Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Mon, 20 Oct 2025 13:54:14 -0400 Subject: [PATCH 05/12] chore: Backport #19 from 'main' to the 'v2' branch --- .github/workflows/test.yml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ff6486fe..a5d94314 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -17,6 +17,9 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: false # Allow previous workflows’ clean-up steps to complete +env: + TESTING_REPOSITORY: github/accessibility-scanner-testing + jobs: test: name: Test @@ -74,7 +77,7 @@ jobs: login_url: http://127.0.0.1:4000/ username: ${{ secrets.TEST_USERNAME }} password: ${{ secrets.TEST_PASSWORD }} - repository: github/accessibility-scanner-testing + repository: ${{ env.TESTING_REPOSITORY }} token: ${{ secrets.GH_TOKEN }} cache_key: ${{ steps.cache_key.outputs.cache_key }} @@ -110,6 +113,11 @@ jobs: if [[ "$URL" == *"/pull/"* ]]; then echo "Closing pull request: $URL" gh pr close "$URL" || echo "Failed to close pull request: $URL" + branch="$(gh pr view "$URL" --json headRefName -q .headRefName || true)" + if [[ -n "$branch" ]]; then + echo "Deleting branch: $branch" + gh api -X DELETE "repos/${{ env.TESTING_REPOSITORY }}/git/refs/heads/$branch" || echo "Failed to delete branch: $branch" + fi elif [[ "$URL" == *"/issues/"* ]]; then echo "Closing issue: $URL" gh issue close "$URL" || echo "Failed to close issue: $URL" From 369d99bcee95068d35c967ca283d447280d1238b Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Tue, 21 Oct 2025 15:16:17 -0400 Subject: [PATCH 06/12] fix(Find): Replace single quotes in the 'html' field because they break single-quoted shell strings --- .github/actions/find/src/findForUrl.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/actions/find/src/findForUrl.ts b/.github/actions/find/src/findForUrl.ts index c1946454..5e2cd7ed 100644 --- a/.github/actions/find/src/findForUrl.ts +++ b/.github/actions/find/src/findForUrl.ts @@ -16,12 +16,12 @@ export async function findForUrl(url: string, authContext?: AuthContext): Promis findings = rawFindings.violations.map(violation => ({ scannerType: 'axe', url, - html: violation.nodes[0].html, - problemShort: violation.help.toLowerCase().replace(/[']/g, '’'), - problemUrl: violation.helpUrl.replace(/[']/g, '’'), + html: violation.nodes[0].html.replace(/'/g, "'"), + problemShort: violation.help.toLowerCase().replace(/'/g, "'"), + problemUrl: violation.helpUrl.replace(/'/g, "'"), ruleId: violation.id, - solutionShort: violation.description.toLowerCase().replace(/[']/g, '’'), - solutionLong: violation.nodes[0].failureSummary?.replace(/[']/g, '’') + solutionShort: violation.description.toLowerCase().replace(/'/g, "'"), + solutionLong: violation.nodes[0].failureSummary?.replace(/'/g, "'") })); } catch (e) { // do something with the error From a662744b66425462a53722db14c6ac2b6261a5a4 Mon Sep 17 00:00:00 2001 From: Carie Fisher <15240149+cehfisher@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:11:46 -0500 Subject: [PATCH 07/12] Add accessibility optimization link to README Added link for optimizing GitHub Copilot for accessibility. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f21444f..7208ac5c 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ The a11y scanner leverages Copilot coding agent, which can be configured with cu - Repository-wide: `.github/copilot-instructions.md` - Directory/file-scoped: `.github/instructions/*.instructions.md` -📚 [Adding repository custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions) | [Copilot .instructions.md support](https://github.blog/changelog/2025-07-23-github-copilot-coding-agent-now-supports-instructions-md-custom-instructions/) | [Copilot agents.md support](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions) +📚 [Adding repository custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions) | [Copilot .instructions.md support](https://github.blog/changelog/2025-07-23-github-copilot-coding-agent-now-supports-instructions-md-custom-instructions/) | [Copilot agents.md support](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions) | [Optimizing GitHub Copilot for accessibility](https://accessibility.github.com/documentation/guide/copilot-instructions) --- From d25ea191e866fa2b18aef89af589c592b75ffc40 Mon Sep 17 00:00:00 2001 From: Carie Fisher <15240149+cehfisher@users.noreply.github.com> Date: Thu, 23 Oct 2025 13:06:51 -0500 Subject: [PATCH 08/12] Refine README for GitHub Copilot references Updated references from 'Copilot' to 'GitHub Copilot' and improved clarity in the README. --- README.md | 106 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 64 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 7208ac5c..a415cf58 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,36 @@ # AI-powered Accessibility Scanner -The AI-powered Accessibility Scanner (a11y scanner) is a GitHub Action that detects accessibility barriers across your digital products, creates trackable issues, and leverages Copilot for AI-powered fixes. +The AI-powered Accessibility Scanner (a11y scanner) is a GitHub Action that detects accessibility barriers across your digital products, creates trackable issues, and leverages GitHub Copilot for AI-powered fixes. The a11y scanner helps teams: - 🔍 Scan websites, files, repositories, and dynamic content for accessibility issues -- 📝 Create actionable GitHub issues that can be assigned to Copilot -- 🤖 Propose fixes with Copilot, with humans reviewing before merging +- 📝 Create actionable GitHub issues that can be assigned to GitHub Copilot +- 🤖 Propose fixes with GitHub Copilot, with humans reviewing before merging -> ⚠️ **Note:** The a11y scanner is currently in beta. It can help identify accessibility gaps but cannot guarantee fully accessible code suggestions. Always review before merging! +> ⚠️ **Note:** The a11y scanner is currently in public preview. Feature development work is still ongoing. It can help identify accessibility gaps but cannot guarantee fully accessible code suggestions. Always review before merging! + +🎥 **[Watch the demo video](https://youtu.be/CvRJcEzCSQM)** to see the a11y scanner in action. --- ## Requirements -This project is a GitHub Actions action. A GitHub Actions workflow is required to run it, and you must have available GitHub Actions minutes. +To use the a11y scanner, you'll need: + +- **GitHub Actions** enabled in your repository +- **GitHub Issues** enabled in your repository +- **Available GitHub Actions minutes** for your account +- **Admin access** to add repository secrets +- **GitHub Copilot** (optional) - The a11y scanner works without GitHub Copilot and will still create issues for accessibility findings. However, without GitHub Copilot, you won't be able to automatically assign issues to GitHub Copilot for AI-powered fix suggestions and PR creation. -📚 [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) -## Getting Started +## Getting started -### 1. Add a Workflow File +### 1. Add a workflow file Create a workflow file in `.github/workflows/` (e.g., `a11y-scan.yml`) in your repository: -```YAML +```yaml name: Accessibility Scanner on: workflow_dispatch # This configures the workflow to run manually, instead of (e.g.) automatically in every PR. Check out https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#on for more options. @@ -36,49 +43,64 @@ jobs: urls: | # Provide a newline-delimited list of URLs to scan; more information below. REPLACE_THIS 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. - 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. - 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. + 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 cannot be used here. + 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 scanned. + # login_url: # Optional: URL of the login page if authentication is required + # username: # Optional: Username for authentication + # password: ${{ secrets.PASSWORD }} # Optional: Password for authentication (use secrets!) + # auth_context: # Optional: Stringified JSON object for complex authentication + # skip_copilot_assignment: false # Optional: Set to true to skip assigning issues to GitHub Copilot (or if you don't have GitHub Copilot) ``` > 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details. -Required Permissions: +**Required permissions:** - Write access to add or update workflows - Admin access to add repository secrets -📚 [Understanding GitHub Actions](https://docs.github.com/en/actions/get-started/understand-github-actions) | [Managing GitHub Actions settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository) | [Writing workflows](https://docs.github.com/en/actions/how-tos/write-workflows) +📚 Learn more +- [Quickstart for GitHub Actions](https://docs.github.com/en/actions/get-started/quickstart) +- [Understanding GitHub Actions](https://docs.github.com/en/actions/get-started/understand-github-actions) +- [Writing workflows](https://docs.github.com/en/actions/how-tos/write-workflows) +- [Managing GitHub Actions settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository) +- [GitHub Actions billing](https://docs.github.com/en/billing/concepts/product-billing/github-actions) --- -### 2. Create a Token and Add a Secret +### 2. Create a token and add a secret -The a11y scanner requires a Personal Access Token (PAT) as repository secret: +The a11y scanner requires a Personal Access Token (PAT) as a repository secret: -#### The `GH_TOKEN` is a fine-grained PAT with +**The `GH_TOKEN` is a fine-grained PAT with:** - `actions: write` - `contents: write` - `issues: write` - `pull-requests: write` - `metadata: read` -- Scope: Your target repository (where issues and PRs will be created) and the repository containing your workflow +- **Scope:** Your target repository (where issues and PRs will be created) and the repository containing your workflow -> 👉 GitHub Actions' default `GITHUB_TOKEN` cannot be used here. +> 👉 GitHub Actions' default [GITHUB_TOKEN](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) cannot be used here. -📚 [Creating a fine-grained PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) | [Creating repository secrets](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository) +📚 Learn more +- [Creating a fine-grained PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) +- [Creating repository secrets](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository) --- -### 3. Run Your First Scan +### 3. Run your first scan -Trigger the workflow manually or automatically based on your configuration. The scanner will run and create issues for any accessibility findings. When issues are assigned to Copilot, always review proposed fixes before merging. +Trigger the workflow manually or automatically based on your configuration. The a11y scanner will run and create issues for any accessibility findings. When issues are assigned to GitHub Copilot, always review proposed fixes before merging. -📚 [Running a workflow manually](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow#running-a-workflow) +📚 Learn more +- [View workflow run history](https://docs.github.com/en/actions/how-tos/monitor-workflows/view-workflow-run-history) +- [Running a workflow manually](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow#running-a-workflow) +- [Re-run workflows and jobs](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs) --- -## Action Inputs +## Action inputs | Input | Required | Description | Example | |-------|----------|-------------|---------| @@ -88,9 +110,9 @@ Trigger the workflow manually or automatically based on your configuration. The | `cache_key` | Yes | Key for caching results across runs
Allowed: `A-Za-z0-9._/-` | `cached_results-primer.style-main.json` | | `login_url` | No | If scanned pages require authentication, the URL of the login page | `https://github.com/login` | | `username` | No | If scanned pages require authentication, the username to use for login | `some-user` | -| `password` | No | If scanned pages require authentication, the password to use for login | `correct-horse-battery-staple` | -| `auth_context` | No | If scanned pages require authentication, a stringified JSON object containing username, password, cookies, and/or localStorage from an authenticated session | `{"username":"some-user","password":"correct-horse-battery-staple","cookies":[{"name":"theme-preference","value":"light","domain":"primer.style","path":"/"}],"localStorage":{"https://primer.style":{"theme-preference":"light"}}}` | -| `skip_copilot_assignment` | No | Whether to skip assigning filed issues to Copilot | `true` | +| `password` | No | If scanned pages require authentication, the password to use for login | `${{ secrets.PASSWORD }}` | +| `auth_context` | No | If scanned pages require authentication, a stringified JSON object containing username, password, cookies, and/or localStorage from an authenticated session | `{"username":"some-user","password":"***","cookies":[...]}` | +| `skip_copilot_assignment` | No | Whether to skip assigning filed issues to GitHub Copilot. Set to `true` if you don't have GitHub Copilot or prefer to handle issues manually | `true` | --- @@ -98,44 +120,44 @@ Trigger the workflow manually or automatically based on your configuration. The If access to a page requires logging-in first, and logging-in requires only a username and password, then provide the `login_url`, `username`, and `password` inputs. -If your login flow is more complex—if it requires two-factor authentication, single sign-on, passkeys, etc.–and you have a custom action that [authenticates with Playwright](https://playwright.dev/docs/auth) and persists authenticated session state to a file, then provide the `auth_context` input. (If `auth_context` is provided, `login_url`, `username`, and `password` will be ignored.) +If your login flow is more complex—if it requires two-factor authentication, single sign-on, passkeys, etc.—and you have a custom action that [authenticates with Playwright](https://playwright.dev/docs/auth) and persists authenticated session state to a file, then provide the `auth_context` input. (If `auth_context` is provided, `login_url`, `username`, and `password` will be ignored.) > [!IMPORTANT] -> Don’t put passwords in your workflow as plain text; instead reference a [repository secret](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository). +> Don't put passwords in your workflow as plain text; instead reference a [repository secret](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository). --- -## Configuring Copilot +## Configuring GitHub Copilot -The a11y scanner leverages Copilot coding agent, which can be configured with custom instructions: +The a11y scanner leverages GitHub Copilot coding agent, which can be configured with custom instructions: -- Repository-wide: `.github/copilot-instructions.md` -- Directory/file-scoped: `.github/instructions/*.instructions.md` +- **Repository-wide:** `.github/copilot-instructions.md` +- **Directory/file-scoped:** `.github/instructions/*.instructions.md` -📚 [Adding repository custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions) | [Copilot .instructions.md support](https://github.blog/changelog/2025-07-23-github-copilot-coding-agent-now-supports-instructions-md-custom-instructions/) | [Copilot agents.md support](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions) | [Optimizing GitHub Copilot for accessibility](https://accessibility.github.com/documentation/guide/copilot-instructions) +📚 Learn more +- [Adding repository custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions) +- [Optimizing GitHub Copilot for accessibility](https://accessibility.github.com/documentation/guide/copilot-instructions) +- [GitHub Copilot .instructions.md support](https://github.blog/changelog/2025-07-23-github-copilot-coding-agent-now-supports-instructions-md-custom-instructions/) +- [GitHub Copilot agents.md support](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions) --- ## Feedback -Please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file for more information. +💬 We welcome your feedback! To submit feedback or report issues, please create an issue in this repository. For more information on contributing, please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file. ## License -This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms. +📄 This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms. ## Maintainers -Please refer to the [CODEOWNERS](./.github/CODEOWNERS) file for more information. +🔧 Please refer to the [CODEOWNERS](./.github/CODEOWNERS) file for more information. ## Support -Please refer to the [SUPPORT](./SUPPORT.md) file for more information. +❓ Please refer to the [SUPPORT](./SUPPORT.md) file for more information. ## Acknowledgement -Thank you to our beta testers for their help in testing this project. - ---- - -*Last updated: 2025-10-09* +✨ Thank you to our beta testers for their help making this project! From 720298e9c1b88de4983c54d3c0b1ec67bb505cfe Mon Sep 17 00:00:00 2001 From: Carie Fisher <15240149+cehfisher@users.noreply.github.com> Date: Thu, 23 Oct 2025 13:10:20 -0500 Subject: [PATCH 09/12] Revise contributing guidelines for clarity and detail Updated the contributing guidelines to clarify contribution process and provide detailed instructions for creating issues and feature requests. --- CONTRIBUTING.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56858a32..3f67fb76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -## Contributing +# Contributing [fork]: https://github.com/github/accessibility-scanner/fork [pr]: https://github.com/github/accessibility-scanner/compare @@ -9,13 +9,29 @@ Contributions to this project are [released](https://help.github.com/articles/gi Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. -## Submitting a pull request +## How you can contribute -Thank you for your interest in this GitHub action, however, right now we are not taking contributions. +We are not accepting pull requests at this time. However, we welcome and encourage you to: +- **Test the a11y scanner** and share your experiences +- **Create issues** to report bugs, unexpected behavior, or documentation improvements +- **Share feedback** about your use cases and workflows + +### Creating issues + +When creating an issue, please provide: + +- A clear and descriptive title +- Detailed steps to reproduce (for bugs) +- Expected vs. actual behavior +- Your environment details (OS, browser, GitHub Actions runner, etc.) +- Any relevant logs or screenshots + +### Feature requests + +While we welcome feature requests, please note that we cannot guarantee that any feature request will be implemented or prioritized. We review all suggestions and consider them as part of our ongoing development process. ## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) -- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) - [GitHub Support](https://support.github.com) From 56c490cfc20e9398caa23dd74201a5c70f0db776 Mon Sep 17 00:00:00 2001 From: Carie Fisher <15240149+cehfisher@users.noreply.github.com> Date: Thu, 23 Oct 2025 13:15:35 -0500 Subject: [PATCH 10/12] Revise support guidelines and maintenance status Updated support documentation to clarify issue filing and project maintenance status. --- SUPPORT.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/SUPPORT.md b/SUPPORT.md index ac1f6a38..12ca97da 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,19 +1,21 @@ # Support -## How to file issues and get help +## How to get help -This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue. +This project uses GitHub Issues to track bugs, feature requests, and support inquiries. Please search the existing issues before filing new issues to avoid duplicates. For help or questions about using this project, please open an issue for support requests, usage questions, or general inquiries. At this time, GitHub Discussions are not enabled. All communication should occur via issues. -## Project Maintenance Status +For information about contributing to this project, including how to create issues and what types of contributions we accept, please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file. + +## Project maintenance status This repo `github/accessibility-scanner` is under active development and maintained by GitHub staff during the public preview state. We will do our best to respond to support, feature requests, and community questions in a timely manner. -## Important Notice +## Important notice -This project is a work in progress, and we do not guarantee that code fixes or suggestions produced by Copilot will be fully accessible. Please use caution when applying the suggestions it provides. Always confirm or verify Copilot's recommendations with an accessibility subject matter expert before using them in production. +The a11y scanner is currently in public preview and feature development work is still ongoing. This project cannot guarantee that code fixes or suggestions produced by GitHub Copilot will be fully accessible. Please use caution when applying the suggestions it provides. Always confirm or verify GitHub Copilot's recommendations with an accessibility subject matter expert before using them in production. -## GitHub Support Policy +## GitHub support policy Support for this project is limited to the resources listed above (GitHub Issues). From 79ec4a87f52a73c1ebce96ecbf4532d8037b6ef0 Mon Sep 17 00:00:00 2001 From: Carie Fisher <15240149+cehfisher@users.noreply.github.com> Date: Thu, 23 Oct 2025 13:23:40 -0500 Subject: [PATCH 11/12] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a415cf58..62c3cf80 100644 --- a/README.md +++ b/README.md @@ -160,4 +160,4 @@ The a11y scanner leverages GitHub Copilot coding agent, which can be configured ## Acknowledgement -✨ Thank you to our beta testers for their help making this project! +✨ Thank you to our beta testers for their help with making this project! From c166e729239963412d8bf01654435de8f3bcdda3 Mon Sep 17 00:00:00 2001 From: Clay Miller Date: Tue, 28 Oct 2025 15:19:59 -0400 Subject: [PATCH 12/12] =?UTF-8?q?fix:=20Set=20'results'=20output=E2=80=99s?= =?UTF-8?q?=20value?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- action.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/action.yml b/action.yml index 35eeab24..84414f54 100644 --- a/action.yml +++ b/action.yml @@ -35,6 +35,7 @@ inputs: outputs: results: description: "List of issues and pull requests filed (and their associated finding(s)), as stringified JSON" + value: ${{ steps.results.outputs.results }} runs: using: "composite"