...
The plugin configuration is flexible and can be customized for the cases when a simple configuration like the one suggested above is not sufficient to your needs.
Required Parameters
Name | Type | Description | -D Parameter |
---|---|---|---|
String | Unique identifier of the organization to update, also known as 'API Token'. | org.whitesource.orgToken Since version 3.1.6 |
Optional Parameters
Name | Type | Description | -D Parameter | ||
---|---|---|---|---|---|
| String | Set logging datetime format. Default value is [HH:mm:ss] | org.whitesource.timeFormat Since version 17.11.3 | ||
Boolean | Set to true to check policies before update. | org.whitesource.checkPolicies Since version 3.1.6 | |||
forceCheckAllDependencies | Boolean | Optional. Set to true to force check all policies for all dependencies, used only if checkPolicies is set to true. | org.whitesource.forceCheckAllDependencies Since version 3.1.7 | ||
forceUpdate | Boolean | Optional. Updates organization inventory regardless of policy violations. | org.whitesource.forceUpdate Since version 3.2.8 | ||
String | Product name or token. | org.whitesource.product Since version 3.2.8 | |||
String | Product version. Use this to override the version in each module. | org.whitesource.productVersion Since version 3.2.8 | |||
String | Unique identifier of the White Source project to update. If omitted, default naming convention will apply. | ||||
Map | Map of module artifactId to White Source project token. See example | ||||
String[] | Only modules with an artifactId matching one of these patterns will be processed by the plugin. Should be used like this:
| ||||
String[] | Modules with an artifactId matching any of these patterns will not be processed by the plugin. Should be used like this:
| ||||
Boolean | Set to true to ignore this maven project. Overrides any include patterns. | ||||
Boolean | Set to true to ignore this maven modules of type pom. | org.whitesource.ignorePomModules Since version 3.2.8 | |||
ignoredScopes | String[] | By default the maven plugin ignores direct dependencies with scope 'test' and 'provided'. | org.whitesource.ignoredScopes Since version 3.3.1 | ||
Boolean | Indicates whether the build will continue even if there are errors. | org.whitesource.failOnError Since version 3.2.8 | |||
Boolean | Set to true to skip the maven execution. | ||||
Boolean | Set to true to create the check policies report as a text file in JSON format instead of the regular HTML format report. | ||||
Boolean | Set to true to combine all pom modules into a single WhiteSource project with an aggregated dependency flat list (no hierarchy). | org.whitesource.aggregateModules Since version 3.2.8 | |||
preserveModuleInfo | Boolean | Optional. Works only if the 'aggregateModules' parameter is set to 'true'. It creates a hierarchy tree for modules that appear in the root POM. | org.whitesource.preserveModuleInfo Since version 18.5.2 | ||
aggregateProjectName | String | Optional. The project name that will appear in WhiteSource. If omitted and no project token defined, defaults to pom artifactId. | org.whitesource.aggregateProjectName Since version 3.2.8 | ||
aggregateProjectToken | String | Optional. Unique identifier of the White Source project to update, overrides aggregateProjectName. If omitted, default naming convention will apply. | org.whitesource.aggregateProjectToken Since version 3.2.8 | ||
requesterEmail | String | Optional. The provided email will be matched with an existing WhiteSource account. Requests for new libraries will be created with the matched account as the requester. | org.whitesource.requesterEmail Since version 3.2.8 | ||
autoDetectProxySettings | Boolean | Indicates whether to try to detect proxy configuration in the underlying machine (e.g. in OS proxy settings, in JVM system properties etc.) | org.whitesource.autoDetectProxySettings Since version 3.2.8 | ||
connectionTimeoutMinutes | int | Connection timeout in minutes. | wss.connectionTimeoutMinutes Since version 3.2.7 | ||
ignoreDependencyResolutionErrors | Boolean | Indicates whether to ignore an error while resolving dependencies for a module, this module will not be included in the scan and will not appear as a project within WhiteSource. | org.whitesource.ignoreDependencyResolutionErrors Since version 3.3.0 | ||
failOnConnectionError | Boolean | Fails the build when unable to connect to WhiteSource service | org.whitesource.failOnConnectionError Since version 3.3.1 | ||
connectionRetries | int | Connection retries when unable to connect to WhiteSource service. | org.whitesource.connectionRetries Since version 3.3.1 | ||
orgTokenFile | String | Optional. Path to file that contains the org token. Use this to override the orgToken parameter in the pom.xml file. | org.whitesource.orgTokenFile Since version 18.2.2 | ||
userKey | String | Unique identifier of user, can be generate from the profile page in your whitesource account. Required if WhiteSource administrator has enabled "Enforce user level access" option. | org.whitesource.userKey Since version 18.4.2 | ||
userKeyFile | String | Optional. Path to file that contains the userKey . Use this to override the userKey parameter in the pom.xml file. | org.whitesource.userKeyFile Since version 18.4.2 | ||
updateEmptyProject | Boolean | Optional. Whether or not to upload/update an empty project | org.whitesource.updateEmptyProject Since version 19.5.1 |
Tip |
---|
If you didn't find what you need, you can try the plugin documentation or drop a line to our support team. |
Check Policies Report
The generated check policies report is located in project_location\target\site\whitesource, there are two types of report formats:
...