Package org.apache.maven.scm.plugin

Class CheckLocalModificationsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.CheckLocalModificationsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="check-local-modification")
public class CheckLocalModificationsMojo
extends AbstractScmMojo

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

Since:

1.2

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	baseDirectory	current directory
private java.lang.String	errorMessage	Custom error message
private boolean	skip	Skip the check for local modifications if set to true.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckLocalModificationsMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.scm.plugin.AbstractScmMojo

checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

errorMessage

@Parameter(property="scm.checkLocalModification.errorMessage",
           defaultValue="The build will stop as there is local modifications")
private java.lang.String errorMessage

Custom error message

skip

@Parameter(property="scm.checkLocalModification.skip",
           defaultValue="false")
private boolean skip

Skip the check for local modifications if set to true.

baseDirectory

@Parameter(defaultValue="${basedir}",
           readonly=true)
private java.io.File baseDirectory

current directory

Constructor Detail

CheckLocalModificationsMojo

public CheckLocalModificationsMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractScmMojo

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractScmMojo

Throws:

org.apache.maven.plugin.MojoExecutionException