updated documentation per issue #782

This commit is contained in:
Jeremy Long
2017-07-03 08:04:54 -04:00
parent 6e2b82c446
commit 305db5f8b1
5 changed files with 60 additions and 18 deletions

View File

@@ -3,13 +3,28 @@ Tasks
Task | Description
----------------------------------------------------|-----------------------
[dependencyCheck](configuration.html) | Runs dependency-check against the project and generates a report.
[dependencyCheckAnalyze](configuration.html) | Runs dependency-check against the project and generates a report.
[dependencyCheckUpdate](configuration-update.html) | Updates the local cache of the NVD data from NIST.
dependencyCheckPurge | Deletes the local copy of the NVD. This is used to force a refresh of the data.
Configuration: dependencyCheckPurge
Configuration
====================
The following properties can be configured for the dependencyCheckPurge task:
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.owasp:dependency-check-gradle:${project.version}'
}
}
apply plugin: 'org.owasp.dependencycheck'
```
```bash
$ gradle dependencyCheckPurge
```
Property | Description | Default Value
---------------------|------------------------------------|------------------
@@ -17,7 +32,8 @@ failOnError | Fails the build if an error occurs during the dependency-
#### Example
```groovy
dependencyCheckPurge {
dependencyCheck {
failOnError=true
}
```
@@ -31,7 +47,7 @@ data | directory | Sets the data directory to hold SQL CVEs cont
#### Example
```groovy
dependencyCheckPurge {
dependencyCheck {
data {
directory='d:/nvd'
}