From eac47800a365d20ec403b2923dc16a5df8eaa183 Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Sun, 8 Jan 2017 08:55:29 -0500 Subject: [PATCH] added documentation for PR #636 --- .../src/site/markdown/configuration.md | 33 ++++++++++--------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/dependency-check-maven/src/site/markdown/configuration.md b/dependency-check-maven/src/site/markdown/configuration.md index 7c4291c06..3197ccc9d 100644 --- a/dependency-check-maven/src/site/markdown/configuration.md +++ b/dependency-check-maven/src/site/markdown/configuration.md @@ -12,22 +12,23 @@ Configuration ==================== The following properties can be set on the dependency-check-maven plugin. -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 -failBuildOnCVSS | Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11 which means since the CVSS scores are 0-10, by default the build will never fail. | 11 -failOnError | Whether the build should fail if there is an error executing the dependency-check analysis | true -format | The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this within the Site plugin unless the externalReport is set to true. | HTML -name | The name of the report in the site | dependency-check or dependency-check:aggregate -outputDirectory | The location to write the report(s). Note, this is not used if generating the report as part of a `mvn site` build | 'target' -skip | Skips the dependency-check analysis | false -skipTestScope | Skip analysis for artifacts with Test Scope | true -skipProvidedScope | Skip analysis for artifacts with Provided Scope | false -skipRuntimeScope | Skip analysis for artifacts with Runtime Scope | false -suppressionFile | The file path to the XML suppression file \- used to suppress [false positives](../general/suppression.html) |   -hintsFile | The file path to the XML hints file \- used to resolve [false negatives](../general/hints.html) |   -enableExperimental | Enable the [experimental analyzers](../analyzers/index.html). If not enabled the experimental analyzers (see below) will not be loaded or used. | false +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 +failBuildOnCVSS | Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11 which means since the CVSS scores are 0-10, by default the build will never fail. | 11 +failBuildOnAnyVulnerability | Specific that if any vulnerability is identified, the build will fail. | false +failOnError | Whether the build should fail if there is an error executing the dependency-check analysis. | true +format | The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this within the Site plugin unless the externalReport is set to true. | HTML +name | The name of the report in the site. | dependency-check or dependency-check:aggregate +outputDirectory | The location to write the report(s). Note, this is not used if generating the report as part of a `mvn site` build. | 'target' +skip | Skips the dependency-check analysis. | false +skipTestScope | Skip analysis for artifacts with Test Scope. | true +skipProvidedScope | Skip analysis for artifacts with Provided Scope. | false +skipRuntimeScope | Skip analysis for artifacts with Runtime Scope. | false +suppressionFile | The file path to the XML suppression file \- used to suppress [false positives](../general/suppression.html). |   +hintsFile | The file path to the XML hints file \- used to resolve [false negatives](../general/hints.html). |   +enableExperimental | Enable the [experimental analyzers](../analyzers/index.html). If not enabled the experimental analyzers (see below) will not be loaded or used. | false Analyzer Configuration ====================