From f54a1f3b7463fe3fa574a2e203b80da9827c2d9d Mon Sep 17 00:00:00 2001 From: Eric Cornelissen Date: Fri, 28 Oct 2022 22:22:55 +0200 Subject: [PATCH] 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"). --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12ef5b2..c2e71b2 100644 --- a/README.md +++ b/README.md @@ -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