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.3:scm
Description:
Generates the Project Source Code Management (SCM) report.
Attributes:
- Requires a Maven 2.0 project to be executed.
- Since version: 2.0.
Required Parameters
Name |
Type |
Since |
Description |
checkoutDirectoryName |
String |
2.0 |
The directory name to checkout right after the SCM URL. Default value is: ${project.artifactId}. |
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.
|
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}. |
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.
|
developerConnection |
String |
2.1 |
The SCM developer connection url respecting the SCM URL Format. Default value is: ${project.scm.developerConnection}. |
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: Yes
- 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
- Expression: ${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
- Expression: ${project.reporting.outputDirectory}
webAccessUrl:
The SCM web access url.
- Type: java.lang.String
- Since: 2.1
- Required: No
- Default: ${project.scm.url}