license:generate-report

Note:This goal should be used as a Maven report.

Full name:

com.puresoltechnologies.maven.plugins:license-maven-plugin:1.2.0:generate-report

Description:

This maven mojo generates a license report out of information generated by a former 'validate' goal run.

Attributes:

  • Requires a Maven project to be executed.
  • Executes only as a reportSet (reporting goal).
  • Requires dependency resolution of artifacts in scope: compile+runtime.
  • Requires dependency collection of artifacts in scope: compile+runtime.
  • The goal is thread-safe and supports parallel builds.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.
  • Invokes the execution of this plugin's goal generate-report prior to executing itself.

Required Parameters

Name Type Since Description
outputDirectory File - Specifies the destination directory where documentation is to be saved to.
Default value is: ${project.build.directory}/licenses.
User property is: destDir.

Optional Parameters

Name Type Since Description
resultsDirectory File - Specifies the results directory where the results of the validate run were saved.
Default value is: ${project.build.directory}/licenses.
skipOptionals boolean - Specified whether or not to skip archetypes with optional flag.
Default value is: false.

Parameter Details

outputDirectory:

Specifies the destination directory where documentation is to be saved to.
  • Type: java.io.File
  • Required: Yes
  • User Property: destDir
  • Default: ${project.build.directory}/licenses

resultsDirectory:

Specifies the results directory where the results of the validate run were saved.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/licenses

skipOptionals:

Specified whether or not to skip archetypes with optional flag.
  • Type: boolean
  • Required: No
  • Default: false