Built by Maven

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:3.6.1:scm

Description:

Generates the Project Source Code Management (SCM) 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
<anonymousConnection> String 2.1 The SCM anonymous connection url respecting the SCM URL Format.
See also: SCM URL Format
Default: ${project.scm.connection}
<checkoutDirectoryName> String - The directory name to checkout right after the SCM URL.
Default: ${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: ${project.basedir}/src/site/custom/project-info-reports.properties
<developerConnection> String 2.1 The SCM developer connection url respecting the SCM URL Format.
See also: SCM URL Format
Default: ${project.scm.developerConnection}
<licenseMappings> List<LicenseMapping> 3.3.1 A mapping of license names to group licenses referred to with different names together
<scmTag> String 2.8 The SCM tag.
Default: ${project.scm.tag}
<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
<webAccessUrl> String 2.1 The SCM web access url.
Default: ${project.scm.url}

Parameter Details

<anonymousConnection>

The SCM anonymous connection url respecting the SCM URL Format.
See also: 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
  • 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-reports.properties

<developerConnection>

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

<licenseMappings>

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

<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}