org.apache.maven.plugins.scmpublish
Class ScmPublishInventoryMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugins.scmpublish.AbstractScmPublishMojo
          org.apache.maven.plugins.scmpublish.ScmPublishInventoryMojo

All Implemented Interfaces:

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

Deprecated. superseded by publish-scm which does the same in on step only and has more features

@Mojo(name="prepare",
      defaultPhase=PRE_SITE,
      aggregator=true)
public class ScmPublishInventoryMojo
extends AbstractScmPublishMojo

Prepare a directory for version-managed site generation. This checks out the specified directory from the SCM, then takes inventory of all the resulting files then deletes every files. This inventory then allows the 'publish' target to tee up deletions as well as modifications and additions. There's an assumption here that an entire directory in SCM is dedicated to the publication process for this project. In the aggregate case, this is going to take some doing. If we allow this to be non-aggregate, then each module has to configure pathnames, which would be a pain. So we assume that in an aggregate project this runs once, at the top -- then all of the projects site-deploy into the file: url this creates. TODO: we want multiple includes/excludes, but the scm API doesn't go there.

Field Summary

Fields inherited from class org.apache.maven.plugins.scmpublish.AbstractScmPublishMojo

automaticRemotePathCreation, basedir, checkoutDirectory, excludes, ignorePathsToDelete, includes, inventoryFile, localCheckout, password, pubScmUrl, scmBranch, scmProvider, scmRepository, scmRepositoryConfigurator, session, settings, siteOutputEncoding, skipDeletedFiles, tryUpdate, username

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

ROLE

Constructor Summary

ScmPublishInventoryMojo()
Deprecated.

Method Summary

void	scmPublishExecute() Deprecated.

Methods inherited from class org.apache.maven.plugins.scmpublish.AbstractScmPublishMojo

checkoutExisting, execute, logError, logInfo, setupScm

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

Constructor Detail

ScmPublishInventoryMojo

public ScmPublishInventoryMojo()

Deprecated.

Method Detail

scmPublishExecute

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

Deprecated.

Specified by:

scmPublishExecute in class AbstractScmPublishMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException