Built by Maven

project-info-reports:index

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

Full name:

org.apache.maven.plugins:maven-project-info-reports-plugin:3.4.3:index

Description:

Generates the Project Index 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.
<licenseMappings> List<LicenseMapping> 3.3.1 A mapping of license names to group licenses referred to with different names together
<pluginRepositories> List<ArtifactRepository> 3.1.0 Plugin repositories used for the project.
User property is: project.pluginArtifactRepositories.
<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

<licenseMappings>

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

<pluginRepositories>

Plugin repositories used for the project.
  • Type: java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>
  • Since: 3.1.0
  • Required: No
  • User Property: project.pluginArtifactRepositories

<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