project-info-reports:scm

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

Full name:

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

Description:

Generates the Project Source Code Management (SCM) 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
anonymousConnection String 2.1 The SCM anonymous connection url respecting the SCM URL Format.
Default value is: ${project.scm.connection}.
checkoutDirectoryName String 2.0 The directory name to checkout right after the SCM URL.
Default value is: ${project.artifactId}.
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.
developerConnection String 2.1 The SCM developer connection url respecting the SCM URL Format.
Default value is: ${project.scm.developerConnection}.
remoteRepositories List 2.1 Remote repositories used for the project.
User property is: project.remoteArtifactRepositories.
scmTag String 2.8 The SCM tag.
Default value is: ${project.scm.tag}.
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.
webAccessUrl String 2.1 The SCM web access url.
Default value is: ${project.scm.url}.

Parameter Details

anonymousConnection:

The SCM anonymous connection url respecting the SCM URL Format.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Default: ${project.scm.connection}

checkoutDirectoryName:

The directory name to checkout right after the SCM URL.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Default: ${project.artifactId}

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

developerConnection:

The SCM developer connection url respecting the SCM URL Format.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Default: ${project.scm.developerConnection}

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

scmTag:

The SCM tag.
  • Type: java.lang.String
  • Since: 2.8
  • Required: No
  • Default: ${project.scm.tag}

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

webAccessUrl:

The SCM web access url.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Default: ${project.scm.url}