org.apache.maven.plugins.scmpublish

Class AbstractScmPublishMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.scmpublish.AbstractScmPublishMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ScmPublishPublishScmMojo

public abstract class AbstractScmPublishMojo
extends org.apache.maven.plugin.AbstractMojo

Base class for the scm-publish mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addUniqueDirectory Add each directory in a separated SCM command: this can be necessary if SCM does not support adding subdirectories in one command.
protected boolean	automaticRemotePathCreation Configure svn automatic remote url creation.
protected File	basedir
protected File	checkoutDirectory Location where the scm check-out is done.
protected String	excludes Patterns to exclude from the scm tree.
protected String[]	extraNormalizeExtensions Extra file extensions to normalize line ending (will be added to default html,css,js list)
protected String[]	ignorePathsToDelete Collections of paths not to delete when checking content to delete.
protected String	includes Patterns to include in the scm tree.
protected boolean	localCheckout Use a local checkout instead of doing a checkout from the upstream repository.
protected String	password The SCM password to use.
protected String	pubScmUrl Location of the scm publication tree: scm:<scm_provider><delimiter><provider_specific_part>.
protected String	scmBranch SCM branch to use.
protected org.apache.maven.scm.provider.ScmProvider	scmProvider
protected org.apache.maven.scm.repository.ScmRepository	scmRepository
protected org.apache.maven.shared.release.scm.ScmRepositoryConfigurator	scmRepositoryConfigurator Tool that gets a configured SCM repository from release configuration.
protected org.apache.maven.settings.Settings	settings
protected String	siteOutputEncoding The outputEncoding parameter of the site plugin.
protected boolean	skipDeletedFiles Do not delete files to the scm
protected String	subDirectory Location where the content is published inside the ${checkoutDirectory}.
protected boolean	tryUpdate If the checkout directory exists and this flag is activated, the plugin will try an SCM-update instead of delete then checkout.
protected String	username The SCM username to use.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractScmPublishMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addFiles(Collection<File> added) Add files to scm.
protected void	checkinFiles() Check-in content from scm checkout.
protected void	checkoutExisting()
protected void	deleteFiles(Collection<File> deleted)
void	execute()
boolean	isDryRun()
protected void	logError(String format, Object... params)
protected void	logInfo(String format, Object... params)
protected void	logWarn(String format, Object... params)
protected boolean	requireNormalizeNewlines(File f)
abstract void	scmPublishExecute()
void	setPubScmUrl(String pubScmUrl)

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

pubScmUrl

@Parameter(property="scmpublish.pubScmUrl",
           defaultValue="${project.distributionManagement.site.url}",
           required=true)
protected String pubScmUrl

Location of the scm publication tree: scm:<scm_provider><delimiter><provider_specific_part>. Example: scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/

tryUpdate

@Parameter(property="scmpublish.tryUpdate",
           defaultValue="false")
protected boolean tryUpdate

If the checkout directory exists and this flag is activated, the plugin will try an SCM-update instead of delete then checkout.

checkoutDirectory

@Parameter(property="scmpublish.checkoutDirectory",
           defaultValue="${project.build.directory}/scmpublish-checkout")
protected File checkoutDirectory

Location where the scm check-out is done. By default, scm checkout is done in build (target) directory, which is deleted on every mvn clean. To avoid this and get better performance, configure this location outside build structure and set tryUpdate to true. See Improving SCM Checkout Performance for more information.

subDirectory

@Parameter(property="scmpublish.subDirectory")
protected String subDirectory

Location where the content is published inside the ${checkoutDirectory}. By default, content is copyed at the root of ${checkoutDirectory}.

excludes

@Parameter
protected String excludes

Patterns to exclude from the scm tree.

includes

@Parameter
protected String includes

Patterns to include in the scm tree.

scmRepositoryConfigurator

@Component
protected org.apache.maven.shared.release.scm.ScmRepositoryConfigurator scmRepositoryConfigurator

Tool that gets a configured SCM repository from release configuration.

username

@Parameter(property="username")
protected String username

The SCM username to use. This value takes precedence over the username derived from serverId.

See Also:

serverId

password

@Parameter(property="password")
protected String password

The SCM password to use. This value takes precedence over the password derived from serverId.

See Also:

serverId

localCheckout

@Parameter(property="localCheckout",
           defaultValue="false")
protected boolean localCheckout

Use a local checkout instead of doing a checkout from the upstream repository. WARNING: This will only work with distributed SCMs which support the file:// protocol. TODO: we should think about having the defaults for the various SCM providers provided via Modello!

siteOutputEncoding

@Parameter(property="outputEncoding",
           defaultValue="${project.reporting.outputEncoding}")
protected String siteOutputEncoding

The outputEncoding parameter of the site plugin. This plugin will corrupt your site if this does not match the value used by the site plugin.

skipDeletedFiles

@Parameter(property="scmpublish.skipDeletedFiles",
           defaultValue="false")
protected boolean skipDeletedFiles

Do not delete files to the scm

addUniqueDirectory

@Parameter(defaultValue="false")
protected boolean addUniqueDirectory

Add each directory in a separated SCM command: this can be necessary if SCM does not support adding subdirectories in one command.

basedir

@Parameter(defaultValue="${basedir}",
           readonly=true)
protected File basedir

settings

@Parameter(defaultValue="${settings}",
           readonly=true,
           required=true)
protected org.apache.maven.settings.Settings settings

ignorePathsToDelete

@Parameter
protected String[] ignorePathsToDelete

Collections of paths not to delete when checking content to delete. If your site has subdirectories published by an other mechanism/build

scmBranch

@Parameter(property="scmpublish.scm.branch")
protected String scmBranch

SCM branch to use. For github, you must configure with gh-pages.

automaticRemotePathCreation

@Parameter(property="scmpublish.automaticRemotePathCreation",
           defaultValue="true")
protected boolean automaticRemotePathCreation

Configure svn automatic remote url creation.

extraNormalizeExtensions

@Parameter
protected String[] extraNormalizeExtensions

Extra file extensions to normalize line ending (will be added to default html,css,js list)

scmProvider

protected org.apache.maven.scm.provider.ScmProvider scmProvider

scmRepository

protected org.apache.maven.scm.repository.ScmRepository scmRepository

Constructor Detail

AbstractScmPublishMojo

public AbstractScmPublishMojo()

Method Detail

logInfo

protected void logInfo(String format,
                       Object... params)

logWarn

protected void logWarn(String format,
                       Object... params)

logError

protected void logError(String format,
                        Object... params)

requireNormalizeNewlines

protected boolean requireNormalizeNewlines(File f)
                                    throws IOException

Throws:

IOException

checkoutExisting

protected void checkoutExisting()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

checkinFiles

protected void checkinFiles()
                     throws org.apache.maven.plugin.MojoExecutionException

Check-in content from scm checkout.

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of issue

deleteFiles

protected void deleteFiles(Collection<File> deleted)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addFiles

protected void addFiles(Collection<File> added)
                 throws org.apache.maven.plugin.MojoFailureException,
                        org.apache.maven.plugin.MojoExecutionException

Add files to scm.

Parameters:

added - files to be added

Throws:

org.apache.maven.plugin.MojoFailureException - in case of issue

org.apache.maven.plugin.MojoExecutionException - in case of issue

isDryRun

public boolean isDryRun()

scmPublishExecute

public abstract void scmPublishExecute()
                                throws org.apache.maven.plugin.MojoExecutionException,
                                       org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

setPubScmUrl

public void setPubScmUrl(String pubScmUrl)