scm-publish:publish

Full name:

org.apache.maven.plugins:maven-scm-publish-plugin:1.0-beta-1:publish

This plugin goal has been deprecated:

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

Description:

Compare the list of files now on disk to the original inventory, then fire off scm adds and deletes as needed.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Binds by default to the lifecycle phase: post-site.

Required Parameters

Name Type Since Description
pubScmUrl String - Location of the scm publication tree.
Default value is: ${project.distributionManagement.site.url}.
User property is: scmpublish.pubScmUrl.

Optional Parameters

Name Type Since Description
automaticRemotePathCreation boolean - for svn avoid automatic remote url create
Default value is: true.
User property is: scmpublish.automaticRemotePathCreation.
checkinComment String - SCM log/checkin comment for this publication.
Default value is: Site checkin for project ${project.name}.
User property is: scmpublish.checkinComment.
checkoutDirectory File - Location where the scm check-out is done.
Default value is: ${project.build.directory}/scmpublish-checkout.
User property is: scmpublish.checkoutDirectory.
dryRun boolean - Display list of added, deleted, and changed files, but do not do any actual SCM operations.
User property is: scmpublish.dryRun.
excludes String - Patterns to exclude from the scm tree.
extraNormalizeExtensions String[] - extra file extensions to normalize line ending (will be added to list html,css,js)
ignorePathsToDelete String[] - Collections of paths to not delete when checking content to delete. If your site has subdirectories published by an other mechanism/build
includes String - Patterns to include in the scm tree.
inventoryFile File - Location of the inventory file.
Default value is: ${project.build.directory}/scmpublish-inventory.js.
User property is: scmpublish.inventoryFile.
localCheckout boolean - Use a local checkout instead of doing a checkout from the upstream repository. ATTENTION: 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!
Default value is: false.
User property is: localCheckout.
password String - The SCM password to use.
User property is: password.
providerImplementations Map - List of SCM provider implementations.
scmBranch String - for github you must configure with gh-pages
User property is: scmpublish.scm.branch.
siteOutputEncoding String - 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.
Default value is: ${project.reporting.outputEncoding}.
User property is: outputEncoding.
skipCheckin boolean - Run add and delete commands, but leave the actually checkin for the user to run manually.
User property is: scmpublish.skipCheckin.
skipDeletedFiles boolean - Do not delete files to the scm
Default value is: false.
User property is: scmpublish.skipDeletedFiles.
tryUpdate boolean - if the checkout directory exists and this flag is activated the plugin will try an update rather than delete then checkout
Default value is: false.
User property is: scmpublish.tryUpdate.
username String - The SCM username to use.
User property is: username.

Parameter Details

automaticRemotePathCreation:

for svn avoid automatic remote url create
  • Type: boolean
  • Required: No
  • User Property: scmpublish.automaticRemotePathCreation
  • Default: true

checkinComment:

SCM log/checkin comment for this publication.
  • Type: java.lang.String
  • Required: No
  • User Property: scmpublish.checkinComment
  • Default: Site checkin for project ${project.name}

checkoutDirectory:

Location where the scm check-out is done.
  • Type: java.io.File
  • Required: No
  • User Property: scmpublish.checkoutDirectory
  • Default: ${project.build.directory}/scmpublish-checkout

dryRun:

Display list of added, deleted, and changed files, but do not do any actual SCM operations.
  • Type: boolean
  • Required: No
  • User Property: scmpublish.dryRun

excludes:

Patterns to exclude from the scm tree.
  • Type: java.lang.String
  • Required: No

extraNormalizeExtensions:

extra file extensions to normalize line ending (will be added to list html,css,js)
  • Type: java.lang.String[]
  • Required: No

ignorePathsToDelete:

Collections of paths to not delete when checking content to delete. If your site has subdirectories published by an other mechanism/build
  • Type: java.lang.String[]
  • Required: No

includes:

Patterns to include in the scm tree.
  • Type: java.lang.String
  • Required: No

inventoryFile:

Location of the inventory file.
  • Type: java.io.File
  • Required: No
  • User Property: scmpublish.inventoryFile
  • Default: ${project.build.directory}/scmpublish-inventory.js

localCheckout:

Use a local checkout instead of doing a checkout from the upstream repository. ATTENTION: 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!
  • Type: boolean
  • Required: No
  • User Property: localCheckout
  • Default: false

password:

The SCM password to use.
  • Type: java.lang.String
  • Required: No
  • User Property: password

providerImplementations:

List of SCM provider implementations.
  • Type: java.util.Map
  • Required: No

pubScmUrl:

Location of the scm publication tree.
  • Type: java.lang.String
  • Required: Yes
  • User Property: scmpublish.pubScmUrl
  • Default: ${project.distributionManagement.site.url}

scmBranch:

for github you must configure with gh-pages
  • Type: java.lang.String
  • Required: No
  • User Property: scmpublish.scm.branch

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.
  • Type: java.lang.String
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

skipCheckin:

Run add and delete commands, but leave the actually checkin for the user to run manually.
  • Type: boolean
  • Required: No
  • User Property: scmpublish.skipCheckin

skipDeletedFiles:

Do not delete files to the scm
  • Type: boolean
  • Required: No
  • User Property: scmpublish.skipDeletedFiles
  • Default: false

tryUpdate:

if the checkout directory exists and this flag is activated the plugin will try an update rather than delete then checkout
  • Type: boolean
  • Required: No
  • User Property: scmpublish.tryUpdate
  • Default: false

username:

The SCM username to use.
  • Type: java.lang.String
  • Required: No
  • User Property: username