Document the license-check & vulnerability-check config options

Include the license-check and vulnerability-check options in the config
documentation in the README.

Also fix a typo in the README ("configuraton" -> "configuration").
This commit is contained in:
Eric Cornelissen
2022-10-28 22:22:55 +02:00
parent 84921e5e4a
commit f54a1f3b74

View File

@@ -71,7 +71,7 @@ or by inlining these options in your workflow file.
### config-file
A string representing the path to an external configuraton file. By
A string representing the path to an external configuration file. By
default external configuration files are not used.
**Possible values**: A string representing the absolute path to the
@@ -155,6 +155,20 @@ allow-ghsas:
- GHSA-efgh-1234-5679
```
### license-check/vulnerability-check
Disable the license checks or vulnerability checks performed by this Action.
You can't disable both checks.
**Possible values**: `true` or `false`
**Example**:
```yaml
license-check: true
vulnerability-check: false
```
### base-ref/head-ref
Provide custom git references for the git base/head when performing