diff --git a/dependency-check-maven/src/site/markdown/configuration.md b/dependency-check-maven/src/site/markdown/configuration.md index efc8cfbe5..cccc733fb 100644 --- a/dependency-check-maven/src/site/markdown/configuration.md +++ b/dependency-check-maven/src/site/markdown/configuration.md @@ -4,6 +4,7 @@ The following properties can be set on the dependency-check-maven plugin. Property | Description | Default Value ---------------------|------------------------------------|------------------ +aggregate | Sets whether report aggregation will be performed for multi-module site reports. This option only affects the report generation when configured within the reporting section. | false autoUpdate | Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false. | true 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' 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 diff --git a/dependency-check-maven/src/site/markdown/usage.md.vm b/dependency-check-maven/src/site/markdown/usage.md.vm index c04b26e9f..7f9f0a4f1 100644 --- a/dependency-check-maven/src/site/markdown/usage.md.vm +++ b/dependency-check-maven/src/site/markdown/usage.md.vm @@ -17,7 +17,9 @@ Create the DependencyCheck-report.html in the target directory ```xml + ... + ... ... @@ -41,11 +43,47 @@ Create the DependencyCheck-report.html in the target directory ``` $H$H$H Example 2: +Create an aggregated dependency-check report within the site + +```xml + + ... + + ... + + ... + + org.apache.maven.plugins + maven-site-plugin + + + + org.owasp + dependency-check-maven + ${project.version} + + true + + + + + + ... + + ... + + ... + +``` + +$H$H$H Example 3: Create the DependencyCheck-report.html and fail the build for CVSS greater then 8 ```xml + ... + ... ... @@ -71,44 +109,14 @@ Create the DependencyCheck-report.html and fail the build for CVSS greater then ``` -$H$H$H Example 3: -Create the dependency-check report within the site - -```xml - - - - ... - - org.apache.maven.plugins - maven-site-plugin - - - - org.owasp - dependency-check-maven - ${project.version} - - false - - - - - - ... - - ... - - ... - -``` - $H$H$H Example 4: -Create the DependencyCheck-report.html and skip artifacts no bundled in distribution (Provided and Runtime scope) +Create the DependencyCheck-report.html and skip artifacts not bundled in distribution (Provided and Runtime scope) ```xml + ... + ... ... @@ -140,7 +148,9 @@ Create the DependencyCheck-report.html and use internal mirroring of CVE content ```xml + ... + ... ...