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.8.0: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.

Required Parameters

Name Type Since Description
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports

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: ${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: false
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
Default: default
<offline> boolean - Whether the system is currently offline.
User Property: settings.offline
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean 2.8 Skip report.
Default: false
User Property: 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: 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

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<offline>

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

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<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