From 4b6d3816687cbdeeac8a33939a34fd7afbfda56c Mon Sep 17 00:00:00 2001 From: Lindsey Wild <35239154+lindseywild@users.noreply.github.com> Date: Thu, 30 Apr 2026 10:05:51 -0400 Subject: [PATCH 1/4] Update PLUGINS.md with workflow setup instructions Added instructions for using the actions/checkout step in workflows. --- PLUGINS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/PLUGINS.md b/PLUGINS.md index 85c99ed..70caf16 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -30,6 +30,18 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For - Each plugin should have one `index.ts` OR `index.js` file inside its folder. - The `index.ts/index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So if the plugin exports a name value of `my-custom-plugin` and we pass the following to the scanner action inputs: `scans: ['my-custom-plugin']`, it would cause the scanner to only run that plugin. - The `index.ts/index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function. +- To your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so: + +``` +jobs: + accessibility_scanner: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - uses: github/accessibility-scanner@v3 + with: + ... the rest of the workflow setup +``` ## Things to look out for From 77a9d514c749a81bebf7ba02a6cef9313ec355ba Mon Sep 17 00:00:00 2001 From: Lindsey Wild <35239154+lindseywild@users.noreply.github.com> Date: Thu, 30 Apr 2026 10:27:10 -0400 Subject: [PATCH 2/4] Update PLUGINS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- PLUGINS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLUGINS.md b/PLUGINS.md index 70caf16..d044fc4 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -32,7 +32,7 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For - The `index.ts/index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function. - To your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so: -``` +```yaml jobs: accessibility_scanner: runs-on: ubuntu-latest From 551f29c16942d77a18982ed7f806cc60804250b1 Mon Sep 17 00:00:00 2001 From: Lindsey Wild <35239154+lindseywild@users.noreply.github.com> Date: Thu, 30 Apr 2026 10:27:25 -0400 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- PLUGINS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PLUGINS.md b/PLUGINS.md index d044fc4..dcef1c6 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -30,7 +30,7 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For - Each plugin should have one `index.ts` OR `index.js` file inside its folder. - The `index.ts/index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So if the plugin exports a name value of `my-custom-plugin` and we pass the following to the scanner action inputs: `scans: ['my-custom-plugin']`, it would cause the scanner to only run that plugin. - The `index.ts/index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function. -- To your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so: +- In your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so: ```yaml jobs: @@ -40,7 +40,7 @@ jobs: - uses: actions/checkout@v6 - uses: github/accessibility-scanner@v3 with: - ... the rest of the workflow setup + # ... the rest of the workflow setup ``` ## Things to look out for From 55e52b7d0f196cc66e1732b791f4661069f1f910 Mon Sep 17 00:00:00 2001 From: Lindsey Wild <35239154+lindseywild@users.noreply.github.com> Date: Thu, 30 Apr 2026 13:09:57 -0400 Subject: [PATCH 4/4] Update plugin instructions in PLUGINS.md Clarify instructions for adding plugins to the scanner. --- PLUGINS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PLUGINS.md b/PLUGINS.md index dcef1c6..7f3058f 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -30,7 +30,7 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For - Each plugin should have one `index.ts` OR `index.js` file inside its folder. - The `index.ts/index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So if the plugin exports a name value of `my-custom-plugin` and we pass the following to the scanner action inputs: `scans: ['my-custom-plugin']`, it would cause the scanner to only run that plugin. - The `index.ts/index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function. -- In your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so: +- In your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is). This allows the current repository's files (where your custom plugin's file exists) to be read: ```yaml jobs: