Built by Maven

scm:list

Full name:

org.apache.maven.plugins:maven-scm-plugin:2.1.0:list

Description:

Get the list of project files.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<basedir> File - The base directory.
User Property: basedir

Optional Parameters

Name Type Since Description
<connectionType> String - The type of connection to use (connection or developerConnection).
Default: connection
User Property: connectionType
<connectionUrl> String - The SCM connection URL.
Default: ${project.scm.connection}
User Property: connectionUrl
<developerConnectionUrl> String - The SCM connection URL for developers.
Default: ${project.scm.developerConnection}
User Property: developerConnectionUrl
<excludes> String - Comma separated list of excludes file pattern.
User Property: excludes
<includes> String - Comma separated list of includes file pattern.
User Property: includes
<passphrase> String - The passphrase.
User Property: passphrase
<password> String - The user password.
User Property: password
<privateKey> String - The private key.
User Property: privateKey
<providerImplementations> Map<String,String> - List of provider implementations.
<pushChanges> boolean 1.4 Should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.
Default: true
User Property: pushChanges
<recursive> boolean - Use recursive mode.
Default: true
User Property: recursive
<scmVersion> String - The version (revision number/branch name/tag name).
User Property: scmVersion
<scmVersionType> String - The version type (branch/tag/revision) of scmVersion.
User Property: scmVersionType
<systemProperties> Properties - List of System properties to pass to the JUnit tests.
<tagBase> String - The url of tags base directory (used by svn protocol). It is not necessary to set it if you use the standard svn layout (branches/tags/trunk).
User Property: tagBase
<username> String - The user name.
User Property: username
<workingDirectory> File - The working directory.
User Property: workingDirectory
<workItem> String 1.9.5 Deprecated. A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
User Property: workItem

Parameter Details

<basedir>

The base directory.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • User Property: basedir

<connectionType>

The type of connection to use (connection or developerConnection).
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: connectionType
  • Default: connection

<connectionUrl>

The SCM connection URL.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: connectionUrl
  • Default: ${project.scm.connection}

<developerConnectionUrl>

The SCM connection URL for developers.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: developerConnectionUrl
  • Default: ${project.scm.developerConnection}

<excludes>

Comma separated list of excludes file pattern.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: excludes

<includes>

Comma separated list of includes file pattern.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: includes

<passphrase>

The passphrase.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: passphrase

<password>

The user password.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: password

<privateKey>

The private key.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: privateKey

<providerImplementations>

List of provider implementations.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: report.plugin.goal.no

<pushChanges>

Should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.
  • Type: boolean
  • Since: 1.4
  • Required: report.plugin.goal.no
  • User Property: pushChanges
  • Default: true

<recursive>

Use recursive mode.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: recursive
  • Default: true

<scmVersion>

The version (revision number/branch name/tag name).
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: scmVersion

<scmVersionType>

The version type (branch/tag/revision) of scmVersion.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: scmVersionType

<systemProperties>

List of System properties to pass to the JUnit tests.
  • Type: java.util.Properties
  • Required: report.plugin.goal.no

<tagBase>

The url of tags base directory (used by svn protocol). It is not necessary to set it if you use the standard svn layout (branches/tags/trunk).
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: tagBase

<username>

The user name.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: username

<workingDirectory>

The working directory.
  • Type: java.io.File
  • Required: report.plugin.goal.no
  • User Property: workingDirectory

<workItem>

Deprecated. No reason given
A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
  • Type: java.lang.String
  • Since: 1.9.5
  • Required: report.plugin.goal.no
  • User Property: workItem