project-info-reports:mailing-list

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

Full name:

org.apache.maven.plugins:maven-project-info-reports-plugin:2.8:mailing-list

Description:

Generates the Mailing List report.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 2.0.

Required Parameters

Name Type Since Description
outputDirectory File 2.0 The 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 output directory configured in the Maven Site Plugin is used instead.
User property is: project.reporting.outputDirectory.

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-report.properties.
introduction String 2.2 Deprecated. since 2.3, you should use a custom bundle.
remoteRepositories List 2.1 Remote repositories used for the project.
User property is: project.remoteArtifactRepositories.
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-report.properties

introduction:

Deprecated. since 2.3, you should use a custom bundle.
This can override the header text of the mailing list(s) report
  • Type: java.lang.String
  • Since: 2.2
  • Required: No

outputDirectory:

The 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 output directory configured in the Maven Site Plugin is used instead.
  • Type: java.io.File
  • Since: 2.0
  • Required: Yes
  • User Property: project.reporting.outputDirectory

remoteRepositories:

Remote repositories used for the project.
  • Type: java.util.List
  • Since: 2.1
  • Required: No
  • User Property: project.remoteArtifactRepositories

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