whitesource:update

Full name:

org.whitesource:whitesource-maven-plugin:2.1.0:update

Description:

Send updates of open source software usage information to White Source.

Further documentation for the plugin and its usage can be found in the online documentation.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
orgToken String - Unique identifier of the organization to update.
User property is: org.whitesource.orgToken.

Optional Parameters

Name Type Since Description
checkPolicies boolean - Optional. Set to true to check policies.
Default value is: false.
User property is: org.whitesource.checkPolicies.
excludes String[] - Optional. Modules with an artifactId matching any of these patterns will not be processed by the plugin.
User property is: org.whitesource.excludes.
failOnError boolean - Indicates whether the build will continue even if there are errors.
Default value is: false.
ignore boolean - Optional. Set to true to ignore this maven project. Overrides any include patterns.
Default value is: false.
User property is: org.whitesource.ignore.
ignorePomModules boolean - Optional. Set to true to ignore this maven modules of type pom.
Default value is: true.
User property is: org.whitesource.ignorePomModules.
ignoreTestScopeDependencies boolean - Optional. Set to false to include test scope dependencies.
Default value is: true.
User property is: org.whitesource.ignoreTestScopeDependencies.
includes String[] - Optional. Only modules with an artifactId matching one of these patterns will be processed by the plugin.
User property is: org.whitesource.includes.
moduleTokens Map - Optional. Map of module artifactId to White Source project token.
User property is: org.whitesource.moduleTokens.
outputDirectory File - Output directory for checking policies results.
Default value is: ${project.reporting.outputDirectory}.
User property is: org.whitesource.outputDirectory.
product String - Product to update Name or Unique identifier.
User property is: org.whitesource.product.
productVersion String - Product to update version.
User property is: org.whitesource.productVersion.
projectToken String - Optional. Unique identifier of the White Source project to update. If omitted, default naming convention will apply.
User property is: org.whitesource.projectToken.
skip boolean - Set this to 'true' to skip the maven execution.
Default value is: false.
specialModuleTokens Properties - Optional. Use name value pairs for specifying the project tokens to use for modules whose artifactId is not a valid XML tag.
User property is: org.whitesource.specialModuleTokens.

Parameter Details

checkPolicies:

Optional. Set to true to check policies.
  • Type: boolean
  • Required: No
  • User Property: org.whitesource.checkPolicies
  • Default: false

excludes:

Optional. Modules with an artifactId matching any of these patterns will not be processed by the plugin.
  • Type: java.lang.String[]
  • Required: No
  • User Property: org.whitesource.excludes

failOnError:

Indicates whether the build will continue even if there are errors.
  • Type: boolean
  • Required: No
  • Default: false

ignore:

Optional. Set to true to ignore this maven project. Overrides any include patterns.
  • Type: boolean
  • Required: No
  • User Property: org.whitesource.ignore
  • Default: false

ignorePomModules:

Optional. Set to true to ignore this maven modules of type pom.
  • Type: boolean
  • Required: No
  • User Property: org.whitesource.ignorePomModules
  • Default: true

ignoreTestScopeDependencies:

Optional. Set to false to include test scope dependencies.
  • Type: boolean
  • Required: No
  • User Property: org.whitesource.ignoreTestScopeDependencies
  • Default: true

includes:

Optional. Only modules with an artifactId matching one of these patterns will be processed by the plugin.
  • Type: java.lang.String[]
  • Required: No
  • User Property: org.whitesource.includes

moduleTokens:

Optional. Map of module artifactId to White Source project token.
  • Type: java.util.Map
  • Required: No
  • User Property: org.whitesource.moduleTokens

orgToken:

Unique identifier of the organization to update.
  • Type: java.lang.String
  • Required: Yes
  • User Property: org.whitesource.orgToken

outputDirectory:

Output directory for checking policies results.
  • Type: java.io.File
  • Required: No
  • User Property: org.whitesource.outputDirectory
  • Default: ${project.reporting.outputDirectory}

product:

Product to update Name or Unique identifier.
  • Type: java.lang.String
  • Required: No
  • User Property: org.whitesource.product

productVersion:

Product to update version.
  • Type: java.lang.String
  • Required: No
  • User Property: org.whitesource.productVersion

projectToken:

Optional. Unique identifier of the White Source project to update. If omitted, default naming convention will apply.
  • Type: java.lang.String
  • Required: No
  • User Property: org.whitesource.projectToken

skip:

Set this to 'true' to skip the maven execution.
  • Type: boolean
  • Required: No
  • Default: false

specialModuleTokens:

Optional. Use name value pairs for specifying the project tokens to use for modules whose artifactId is not a valid XML tag.
  • Type: java.util.Properties
  • Required: No
  • User Property: org.whitesource.specialModuleTokens