scm:check-local-modification

Full name:

org.kuali.maven.plugins:maven-scm-plugin:1.5-SNAPSHOT:check-local-modification

Description:

This mojo will fail the build if there is any local modifications

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.2.

Required Parameters

Name Type Since Description
basedir File 1.2 The base directory.

Optional Parameters

Name Type Since Description
connectionType String 1.2 The type of connection to use (connection or developerConnection).
Default value is: connection.
connectionUrl String 1.2 The SCM connection URL.
Default value is: ${project.scm.connection}.
developerConnectionUrl String 1.2 The SCM connection URL for developers.
Default value is: ${project.scm.developerConnection}.
errorMessage String 1.2 Custom error message
Default value is: The build will stop as there is local modifications.
excludes String 1.2 Comma separated list of excludes file pattern.
includes String 1.2 Comma separated list of includes file pattern.
passphrase String 1.2 The passphrase (used by java svn).
password String 1.2 The user password (used by svn, starteam and perforce protocol).
privateKey String 1.2 The private key (used by java svn).
providerImplementations Map 1.2 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 value is: true.
skip boolean 1.2 Custom error message
Default value is: false.
systemProperties Properties 1.2 List of System properties to pass to the JUnit tests.
tagBase String 1.2 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).
username String 1.2 The user name (used by svn, starteam and perforce protocol).
workingDirectory File 1.2 The working directory.

Parameter Details

basedir:

The base directory.
  • Type: java.io.File
  • Since: 1.2
  • Required: Yes
  • Expression: ${basedir}

connectionType:

The type of connection to use (connection or developerConnection).
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${connectionType}
  • Default: connection

connectionUrl:

The SCM connection URL.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${connectionUrl}
  • Default: ${project.scm.connection}

developerConnectionUrl:

The SCM connection URL for developers.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${connectionUrl}
  • Default: ${project.scm.developerConnection}

errorMessage:

Custom error message
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${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
  • Since: 1.2
  • Required: No
  • Expression: ${excludes}

includes:

Comma separated list of includes file pattern.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${includes}

passphrase:

The passphrase (used by java svn).
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${passphrase}

password:

The user password (used by svn, starteam and perforce protocol).
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${password}

privateKey:

The private key (used by java svn).
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${privateKey}

providerImplementations:

List of provider implementations.
  • Type: java.util.Map
  • Since: 1.2
  • 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
  • Expression: ${pushChanges}
  • Default: true

skip:

Custom error message
  • Type: boolean
  • Since: 1.2
  • Required: No
  • Expression: ${scm.checkLocalModification.skip}
  • Default: false

systemProperties:

List of System properties to pass to the JUnit tests.
  • Type: java.util.Properties
  • Since: 1.2
  • 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
  • Since: 1.2
  • Required: No
  • Expression: ${tagBase}

username:

The user name (used by svn, starteam and perforce protocol).
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${username}

workingDirectory:

The working directory.
  • Type: java.io.File
  • Since: 1.2
  • Required: No
  • Expression: ${workingDirectory}