Built by Maven

project-info-reports:licenses

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

Full name:

org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.5-SNAPSHOT:licenses

Description:

Generates the Project Licenses report.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
<customBundle> String 2.3 Path for a custom bundle instead of using the default one.
Using this field, you could change the texts in the generated reports.
Default value is: ${project.basedir}/src/site/custom/project-info-reports.properties.
<licenseFileEncoding> String 2.8 Specifies the input encoding of the project's license file(s).
<licenseMappings> List<LicenseMapping> 3.3.1 A mapping of license names to group licenses referred to with different names together
<linkOnly> boolean 2.3 Whether the only render links to the license documents instead of inlining them.
If the system is in offline mode, the linkOnly parameter will be always true.
Default value is: false.
<offline> boolean - Whether the system is currently offline.
User property is: settings.offline.
<skip> boolean 2.8 Skip report.
Default value is: false.
User property is: mpir.skip.
<skipEmptyReport> boolean 2.8 Skip the project info report generation if a report-specific section of the POM is empty. Defaults to true.
Default value is: true.

Parameter Details

<customBundle>

Path for a custom bundle instead of using the default one.
Using this field, you could change the texts in the generated reports.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Default: ${project.basedir}/src/site/custom/project-info-reports.properties

<licenseFileEncoding>

Specifies the input encoding of the project's license file(s).
  • Type: java.lang.String
  • Since: 2.8
  • Required: No

<licenseMappings>

A mapping of license names to group licenses referred to with different names together

<linkOnly>

Whether the only render links to the license documents instead of inlining them.
If the system is in offline mode, the linkOnly parameter will be always true.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Default: false

<offline>

Whether the system is currently offline.
  • Type: boolean
  • Required: No
  • User Property: settings.offline

<skip>

Skip report.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • User Property: mpir.skip
  • Default: false

<skipEmptyReport>

Skip the project info report generation if a report-specific section of the POM is empty. Defaults to true.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Default: true