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.

• 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 ScmRepositoryConfigurator scmRepositoryConfigurator

  Tool that gets a configured SCM repository from release configuration.

• username

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

  The SCM username to use.

• password

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

  The SCM password to use.

• 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

  @Component
  protected 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 ScmProvider scmProvider

• scmRepository

  protected 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 MojoExecutionException

  Throws:

  MojoExecutionException

• execute

  public void execute()
               throws MojoExecutionException,
                      MojoFailureException

  Throws:

  MojoExecutionException

  MojoFailureException

• checkinFiles

  protected void checkinFiles()
                       throws MojoExecutionException

  Check-in content from scm checkout.

  Throws:

  MojoExecutionException

• deleteFiles

  protected void deleteFiles(Collection<File> deleted)
                      throws MojoExecutionException

  Throws:

  MojoExecutionException

• addFiles

  protected void addFiles(Collection<File> added)
                   throws MojoFailureException,
                          MojoExecutionException

  Add files to scm.

  Parameters:

  added - files to be added

  Throws:

  MojoFailureException

  MojoExecutionException

• isDryRun

  public boolean isDryRun()

• scmPublishExecute

  public abstract void scmPublishExecute()
                                  throws MojoExecutionException,
                                         MojoFailureException

  Throws:

  MojoExecutionException

  MojoFailureException

• setPubScmUrl

  public void setPubScmUrl(String pubScmUrl)