license:download-licenses

Full name:

org.kuali.maven.plugins:license-maven-plugin:1.6.1-SNAPSHOT:download-licenses

Description:

Download the license files of all the current project's dependencies, and generate a summary file containing a list of all dependencies and their licenses.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
excludedScopes String 1.0 A filter to exclude some scopes.
Default value is: system.
includeTransitiveDependencies boolean 1.0 Include transitive dependencies when downloading license files.
Default value is: true.
includedScopes String 1.0 A filter to include only some scopes, if let empty then all scopes will be used (no filter).
licensesConfigFile File 1.0 Input file containing a mapping between each dependency and it's license information.
Default value is: ${project.basedir}/src/license/licenses.xml.
licensesOutputDirectory File 1.0 The directory to which the dependency licenses should be written.
Default value is: ${project.build.directory}/generated-resources/licenses.
licensesOutputFile File 1.0 The output file containing a mapping between each dependency and it's license information.
Default value is: ${project.build.directory}/generated-resources/licenses.xml.
offline boolean 1.0 Settings offline flag (will not download anything if setted to true).
Default value is: ${settings.offline}.
quiet boolean 1.0 Don't show warnings about bad or missing license files.
Default value is: false.

Parameter Details

excludedScopes:

A filter to exclude some scopes.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${license.excludedScopes}
  • Default: system

includeTransitiveDependencies:

Include transitive dependencies when downloading license files.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

includedScopes:

A filter to include only some scopes, if let empty then all scopes will be used (no filter).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${license.includedScopes}

licensesConfigFile:

Input file containing a mapping between each dependency and it's license information.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${licensesConfigFile}
  • Default: ${project.basedir}/src/license/licenses.xml

licensesOutputDirectory:

The directory to which the dependency licenses should be written.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${licensesOutputDirectory}
  • Default: ${project.build.directory}/generated-resources/licenses

licensesOutputFile:

The output file containing a mapping between each dependency and it's license information.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${licensesOutputFile}
  • Default: ${project.build.directory}/generated-resources/licenses.xml

offline:

Settings offline flag (will not download anything if setted to true).
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: ${settings.offline}

quiet:

Don't show warnings about bad or missing license files.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false