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,26 @@ 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 | Updates the local cache of the NVD data from NIST.
[dependencyCheckPurge](configuration-purge.html) | Deletes the local copy of the NVD. This is used to force a refresh of the data.
Configuration: dependencyCheckUpdate
Configuration
====================
The following properties can be configured for the dependencyCheckUpdate task:
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.owasp:dependency-check-gradle:${project.version}'
}
}
apply plugin: 'org.owasp.dependencycheck'
check.dependsOn dependencyCheckUpdate
```
Property | Description | Default Value
---------------------|------------------------------------|------------------
@@ -18,7 +31,7 @@ failOnError | Fails the build if an error occurs during the dependency-
#### Example
```groovy
dependencyCheckUpdate {
dependencyCheck {
cveValidForHours=1
}
```
@@ -35,7 +48,7 @@ connectionTimeout | The URL Connection Timeout. |  
#### Example
```groovy
dependencyCheckUpdate {
dependencyCheck {
proxy {
server=some.proxy.server
port=8989
@@ -64,7 +77,7 @@ data | password | The password used when connecting to the data
#### Example
```groovy
dependencyCheckUpdate {
dependencyCheck {
data {
directory='d:/nvd'
}