From 97b2e1a4da1060754da7835cd559118da52f3bc1 Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Tue, 14 Mar 2017 09:06:17 -0400 Subject: [PATCH] added documentation per issue https://github.com/jeremylong/dependency-check-gradle/issues/38 --- .../markdown/dependency-check-gradle/configuration-purge.md | 5 +++++ .../markdown/dependency-check-gradle/configuration-update.md | 1 + src/site/markdown/dependency-check-gradle/configuration.md | 1 + 3 files changed, 7 insertions(+) diff --git a/src/site/markdown/dependency-check-gradle/configuration-purge.md b/src/site/markdown/dependency-check-gradle/configuration-purge.md index 00b5bba6d..3e4c136ce 100644 --- a/src/site/markdown/dependency-check-gradle/configuration-purge.md +++ b/src/site/markdown/dependency-check-gradle/configuration-purge.md @@ -9,6 +9,11 @@ dependencyCheckPurge | Deletes the local copy of Configuration: dependencyCheckPurge ==================== +The following properties can be configured for the dependencyCheckPurge task: + +Property | Description | Default Value +---------------------|------------------------------------|------------------ +failOnError | Fails the build if an error occurs during the dependency-check analysis. | true #### Example ```groovy diff --git a/src/site/markdown/dependency-check-gradle/configuration-update.md b/src/site/markdown/dependency-check-gradle/configuration-update.md index e83f2dc03..f3ab37d35 100644 --- a/src/site/markdown/dependency-check-gradle/configuration-update.md +++ b/src/site/markdown/dependency-check-gradle/configuration-update.md @@ -14,6 +14,7 @@ The following properties can be configured for the dependencyCheckUpdate task: Property | Description | Default Value ---------------------|------------------------------------|------------------ cveValidForHours | Sets the number of hours to wait before checking for new updates from the NVD. | 4 +failOnError | Fails the build if an error occurs during the dependency-check analysis. | true #### Example ```groovy diff --git a/src/site/markdown/dependency-check-gradle/configuration.md b/src/site/markdown/dependency-check-gradle/configuration.md index 7e4183d74..f33730a01 100644 --- a/src/site/markdown/dependency-check-gradle/configuration.md +++ b/src/site/markdown/dependency-check-gradle/configuration.md @@ -15,6 +15,7 @@ Property | Description | Default Value ---------------------|------------------------------------|------------------ autoUpdate | Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false. | true cveValidForHours | Sets the number of hours to wait before checking for new updates from the NVD. | 4 +failOnError | Fails the build if an error occurs during the dependency-check analysis. | true failBuildOnCVSS | Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11; since the CVSS scores are 0-10, by default the build will never fail. | 11 format | The report format to be generated (HTML, XML, VULN, ALL). | HTML outputDirectory | The location to write the report(s). This directory will be located in the build directory. | build/reports