Skip to content

Commit 4b6d381

Browse files
authored
Update PLUGINS.md with workflow setup instructions
Added instructions for using the actions/checkout step in workflows.
1 parent 056191e commit 4b6d381

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

PLUGINS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,18 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For
3030
- Each plugin should have one `index.ts` OR `index.js` file inside its folder.
3131
- 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.
3232
- 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.
33+
- To your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so:
34+
35+
```
36+
jobs:
37+
accessibility_scanner:
38+
runs-on: ubuntu-latest
39+
steps:
40+
- uses: actions/checkout@v6
41+
- uses: github/accessibility-scanner@v3
42+
with:
43+
... the rest of the workflow setup
44+
```
3345

3446
## Things to look out for
3547

0 commit comments

Comments
 (0)