Fork me on GitHub

license:licenses-xml-insert-versions

Full name:

org.codehaus.mojo:license-maven-plugin:2.4.0:licenses-xml-insert-versions

Description:

Insert versions into a licenses.xml file that might have been generated by a *download-licenses mojo with writeVersions set to false.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.19.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<licensesInputFile> File 1.19 The file whose XML content will be used as a base for adding versions. Defaults to licensesOutputFile
User Property: license.licensesInputFile
<licensesOutputFile> File 1.0 The output file containing a mapping between each dependency and its license information.
Default: ${project.build.directory}/generated-resources/licenses.xml
User Property: licensesOutputFile
<licensesOutputFileEncoding> String 1.17 Encoding used to (1) read the file specified in #licensesConfigFile and (2) write the file specified in licensesOutputFile.
Default: ${project.build.sourceEncoding}
User Property: licensesOutputFileEncoding
<licensesOutputFileEol> Eol 1.17 An end of line constant name denoting the EOL string to use when redering the licenses.xml file. Possible values are LF, CRLF, AUTODETECT and PLATFORM.

When the value AUTODETECT is used, the mojo will use whatever EOL value is used in the first existing of the following files: #licensesConfigFile, ${basedir}/pom.xml.

The value PLATFORM is deprecated but still kept for backwards compatibility reasons.


Default: AUTODETECT
User Property: licensesOutputFileEol
<skipDownloadLicenses> boolean 1.19 A flag to skip the goal.
Default: false
User Property: license.skipDownloadLicenses

Parameter Details

<licensesInputFile>

The file whose XML content will be used as a base for adding versions. Defaults to licensesOutputFile
  • Type: java.io.File
  • Since: 1.19
  • Required: report.plugin.goal.no
  • User Property: license.licensesInputFile

<licensesOutputFile>

The output file containing a mapping between each dependency and its license information.
  • Type: java.io.File
  • Since: 1.0
  • Required: report.plugin.goal.no
  • User Property: licensesOutputFile
  • Default: ${project.build.directory}/generated-resources/licenses.xml

<licensesOutputFileEncoding>

Encoding used to (1) read the file specified in #licensesConfigFile and (2) write the file specified in licensesOutputFile.
  • Type: java.lang.String
  • Since: 1.17
  • Required: report.plugin.goal.no
  • User Property: licensesOutputFileEncoding
  • Default: ${project.build.sourceEncoding}

<licensesOutputFileEol>

An end of line constant name denoting the EOL string to use when redering the licenses.xml file. Possible values are LF, CRLF, AUTODETECT and PLATFORM.

When the value AUTODETECT is used, the mojo will use whatever EOL value is used in the first existing of the following files: #licensesConfigFile, ${basedir}/pom.xml.

The value PLATFORM is deprecated but still kept for backwards compatibility reasons.

  • Type: org.codehaus.mojo.license.Eol
  • Since: 1.17
  • Required: report.plugin.goal.no
  • User Property: licensesOutputFileEol
  • Default: AUTODETECT

<skipDownloadLicenses>

A flag to skip the goal.
  • Type: boolean
  • Since: 1.19
  • Required: report.plugin.goal.no
  • User Property: license.skipDownloadLicenses
  • Default: false