release:perform

Perform a release from SCM

Mojo Attributes :

  • Executes as an aggregator plugin.

Required Parameters

Name Type Description
workingDirectory File The checkout directory. Default value is ${project.build.directory}/checkout.

Optional Parameters

Name Type Description
arguments String Additional arguments to pass to the Maven executions, separated by spaces.
connectionUrl String The SCM URL to checkout from. If omitted, the one from the release.properties file is used, followed by the URL from the current POM.
goals String Comma or space separated goals to execute on deployment.
password String The SCM password to use.
pomFileName String The file name of the POM to execute any goals against.
providerImplementations Map List of provider implementations.
releaseManager ReleaseManager No description.
scmCommentPrefix String The message prefix to all scm changes Default value is [maven-release-plugin] .
scmManager ScmManager The SCM manager.
tag String The SCM tag to use.
tagBase String The tag base directory in SVN, you must define it if you don't use the standard svn layout (trunk/tags/branches). For example, http://svn.apache.org/repos/asf/maven/plugins/tags. The URL is an SVN URL and does not include the SCM provider and protocol.
useReleaseProfile boolean Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. Default value is true.
username String The SCM username to use.

Parameter Details

arguments

Additional arguments to pass to the Maven executions, separated by spaces.

  • Type : java.lang.String
  • Required : No
  • Expression : ${arguments}

connectionUrl

The SCM URL to checkout from. If omitted, the one from the release.properties file is used, followed by the URL from the current POM.

  • Type : java.lang.String
  • Required : No
  • Expression : ${connectionUrl}

goals

Comma or space separated goals to execute on deployment.

  • Type : java.lang.String
  • Required : No
  • Expression : ${goals}

password

The SCM password to use.

  • Type : java.lang.String
  • Required : No
  • Expression : ${password}

pomFileName

The file name of the POM to execute any goals against.

  • Type : java.lang.String
  • Required : No
  • Expression : ${pomFileName}

providerImplementations

List of provider implementations.

  • Type : java.util.Map
  • Required : No

releaseManager

No Description.

  • Type : org.apache.maven.shared.release.ReleaseManager
  • Required : No

scmCommentPrefix

The message prefix to all scm changes

  • Type : java.lang.String
  • Required : No
  • Expression : ${scmCommentPrefix}
  • Default : [maven-release-plugin]

scmManager

The SCM manager.

  • Type : org.apache.maven.scm.manager.ScmManager
  • Required : No

tag

The SCM tag to use.

  • Type : java.lang.String
  • Required : No
  • Expression : ${tag}

tagBase

The tag base directory in SVN, you must define it if you don't use the standard svn layout (trunk/tags/branches). For example, http://svn.apache.org/repos/asf/maven/plugins/tags. The URL is an SVN URL and does not include the SCM provider and protocol.

  • Type : java.lang.String
  • Required : No
  • Expression : ${tagBase}

useReleaseProfile

Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.

  • Type : boolean
  • Required : No
  • Expression : ${useReleaseProfile}
  • Default : true

username

The SCM username to use.

  • Type : java.lang.String
  • Required : No
  • Expression : ${username}

workingDirectory

The checkout directory.

  • Type : java.io.File
  • Required : Yes
  • Default : ${project.build.directory}/checkout