scm:check-local-modification
Full name:
org.apache.maven.plugins:maven-scm-plugin:2.2.0:check-local-modification
Description:
This mojo will fail the build if there is any local modifications
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:
1.2.
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: connectionUser 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 |
<errorMessage> |
String |
- |
Custom error message Default: The build will stop as there is local modificationsUser Property: scm.checkLocalModification.errorMessage |
<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. See also: Authentication User Property: passphrase |
<password> |
String |
- |
The user password. See also: Authentication User Property: password |
<privateKey> |
String |
- |
The private key. See also: Authentication User Property: privateKey |
<providerImplementations> |
Map<String,String> |
- |
List of remapped provider implementations. Allows to bind a different implementation than the default one to a provider id. The key is the remapped provider id, the value is the default provider id the implementation is bound to. See also: Supported SCMs |
<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: trueUser Property: pushChanges |
<serverId> |
String |
2.2.0 |
The server id of the server which provides the credentials for the SCM in the settings.xml file. If not set the default lookup uses the SCM URL to construct the server id like this: server-id=scm-host[":"scm-port].
Currently the POM does not allow to specify a server id for the SCM section. Explicit authentication information provided via See also: Authentication User Property: project.scm.id |
<skip> |
boolean |
- |
Skip the check for local modifications if set to true.Default: falseUser Property: scm.checkLocalModification.skip |
<systemProperties> |
Properties |
- |
List of System properties to set before executing the SCM command. |
<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. See also: Authentication User Property: username |
<workItem> |
String |
1.9.5 |
Deprecated. No reason given A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation. User Property: workItem |
<workingDirectory> |
File |
- |
The working directory. User Property: workingDirectory |
Parameter Details
<basedir>
The base directory.
- Type:
java.io.File - Required:
Yes - User Property:
basedir
<connectionType>
The type of connection to use (connection or developerConnection).
- Type:
java.lang.String - Required:
No - User Property:
connectionType - Default:
connection
<connectionUrl>
The SCM connection URL.
- Type:
java.lang.String - Required:
No - User Property:
connectionUrl - Default:
${project.scm.connection}
<developerConnectionUrl>
The SCM connection URL for developers.
- Type:
java.lang.String - Required:
No - User Property:
developerConnectionUrl - Default:
${project.scm.developerConnection}
<errorMessage>
Custom error message
- Type:
java.lang.String - Required:
No - User Property:
scm.checkLocalModification.errorMessage - Default:
The build will stop as there is local modifications
<excludes>
Comma separated list of excludes file pattern.
- Type:
java.lang.String - Required:
No - User Property:
excludes
<includes>
Comma separated list of includes file pattern.
- Type:
java.lang.String - Required:
No - User Property:
includes
<passphrase>
The passphrase.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
passphrase
<password>
The user password.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
password
<privateKey>
The private key.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
privateKey
<providerImplementations>
List of remapped provider implementations. Allows to bind a different implementation than the default one to a provider id. The key is the remapped provider id, the value is the default provider id the implementation is bound to.
See also: Supported SCMs
See also: Supported SCMs
- Type:
java.util.Map<java.lang.String, java.lang.String> - Required:
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:
No - User Property:
pushChanges - Default:
true
<serverId>
The server id of the server which provides the credentials for the SCM in the settings.xml file. If not set the default lookup uses the SCM URL to construct the server id like this:
See also: Authentication
server-id=scm-host[":"scm-port].
Currently the POM does not allow to specify a server id for the SCM section.
Explicit authentication information provided via username, password or privateKey will take precedence.
See also: Authentication
- Type:
java.lang.String - Since:
2.2.0 - Required:
No - User Property:
project.scm.id
<skip>
Skip the check for local modifications if set to
true.- Type:
boolean - Required:
No - User Property:
scm.checkLocalModification.skip - Default:
false
<systemProperties>
List of System properties to set before executing the SCM command.
- Type:
java.util.Properties - Required:
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:
No - User Property:
tagBase
<username>
The user name.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
username
<workItem>
Deprecated.
No reason given
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:
No - User Property:
workItem
<workingDirectory>
The working directory.
- Type:
java.io.File - Required:
No - User Property:
workingDirectory