Skip to content

Commit 55e52b7

Browse files
authored
Update plugin instructions in PLUGINS.md
Clarify instructions for adding plugins to the scanner.
1 parent 551f29c commit 55e52b7

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

PLUGINS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ 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-
- In your workflow file, before the scanner step, add `- uses: actions/checkout@v6` (or whatever the current version is), like so:
33+
- 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:
3434

3535
```yaml
3636
jobs:

0 commit comments

Comments
 (0)