Skip to content

Commit b6140dd

Browse files
committed
update docs more
1 parent 538b7f0 commit b6140dd

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
@@ -42,7 +42,7 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For
4242

4343
- Each separate plugin should be contained in it's own directory in `./.github/scanner-plugins`. For example, `./.github/scanner-plugins/plugin-1` would be 1 plugin loaded by the scanner.
4444
- Each plugin should have one `index.js` file inside its folder.
45-
- The `index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So the following: `scans: ['my-custom-plugin']` would cause the scanner to only run that plugin.
45+
- The `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.
4646
- The `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.
4747

4848
## Things to look out for

0 commit comments

Comments
 (0)