Required Parameters

Name	Type	Since	Description
stagingRepository	String	2.0-beta-8	URL of the staging repository to use. User property is: stagingRepository.
workingDirectory	File	2.0-beta-8	The checkout directory. Default value is: ${project.build.directory}/checkout. User property is: workingDirectory.

Optional Parameters

Name	Type	Since	Description
arguments	String	2.0-beta-8	Additional arguments to pass to the Maven executions, separated by spaces. User property is: arguments.
connectionUrl	String	2.0-beta-8	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. User property is: connectionUrl.
goals	String	2.0-beta-8	A comma or space separated list of goals to execute on deployment. Default value is either deploy or deploy site-deploy, if the project has a <distributionManagement>/<site> element. User property is: goals.
javaHome	File	2.0-beta-8	The JAVA_HOME parameter to use for forked Maven invocations. Default value is: ${java.home}.
localRepoDirectory	File	2.0-beta-8	The command-line local repository directory in use for this build (if specified). Default value is: ${maven.repo.local}.
mavenExecutorId	String	2.0-beta-8	Role hint of the MavenExecutor implementation to use. Default value is: invoker. User property is: mavenExecutorId.
mavenHome	File	2.0-beta-8	The M2_HOME parameter to use for forked Maven invocations. Default value is: ${maven.home}.
password	String	2.0-beta-8	The SCM password to use. User property is: password.
pomFileName	String	2.0-beta-8	The file name of the POM to execute any goals against. User property is: pomFileName.
providerImplementations	Map	2.0-beta-6	Add a new or overwrite the default implementation per provider. The key is the scm prefix and the value is the role hint of the ScmProvider.
pushChanges	boolean	2.1	Implemented with git will or not push changes to the upstream repository. true by default to preserve backward compatibility. Default value is: true. User property is: pushChanges.
releaseProfiles	String	2.0-beta-8	Comma separated profiles to enable on deployment, in addition to active profiles for project execution. User property is: releaseProfiles.
scmCommentPrefix	String	2.0-beta-5	The message prefix to use for all SCM changes. Default value is: [maven-release-plugin] . User property is: scmCommentPrefix.
tag	String	2.0-beta-8	The SCM tag to use. User property is: tag.
tagBase	String	2.0-beta-8	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. User property is: tagBase.
tagNameFormat	String	2.2.0	Format to use when generating the tag name if none is specified. Property interpolation is performed on the tag, but in order to ensure that the interpolation occurs during release, you must use @{...} to reference the properties rather than ${...}. The following properties are available: groupId or project.groupId - The groupId of the root project. artifactId or project.artifactId - The artifactId of the root project. version or project.version - The release version of the root project. Default value is: @{project.artifactId}-@{project.version}. User property is: tagNameFormat.
useReleaseProfile	boolean	2.0-beta-8	Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. Default value is: true. User property is: useReleaseProfile.
username	String	2.0-beta-8	The SCM username to use. User property is: username.

Parameter Details

arguments:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: arguments

---

connectionUrl:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: connectionUrl

---

goals:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: goals

---

javaHome:

• Type: java.io.File
• Since: 2.0-beta-8
• Required: No
• Default: ${java.home}

---

localRepoDirectory:

• Type: java.io.File
• Since: 2.0-beta-8
• Required: No
• Default: ${maven.repo.local}

---

mavenExecutorId:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: mavenExecutorId
• Default: invoker

---

mavenHome:

• Type: java.io.File
• Since: 2.0-beta-8
• Required: No
• Default: ${maven.home}

---

password:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: password

---

pomFileName:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: pomFileName

---

providerImplementations:

• Type: java.util.Map
• Since: 2.0-beta-6
• Required: No

---

pushChanges:

• Type: boolean
• Since: 2.1
• Required: No
• User Property: pushChanges
• Default: true

---

releaseProfiles:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: releaseProfiles

---

scmCommentPrefix:

• Type: java.lang.String
• Since: 2.0-beta-5
• Required: No
• User Property: scmCommentPrefix
• Default: [maven-release-plugin]

---

stagingRepository:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: Yes
• User Property: stagingRepository

---

tag:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: tag

---

tagBase:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: tagBase

---

tagNameFormat:

• Type: java.lang.String
• Since: 2.2.0
• Required: No
• User Property: tagNameFormat
• Default: @{project.artifactId}-@{project.version}

---

useReleaseProfile:

• Type: boolean
• Since: 2.0-beta-8
• Required: No
• User Property: useReleaseProfile
• Default: true

---

username:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: username

---

workingDirectory:

• Type: java.io.File
• Since: 2.0-beta-8
• Required: Yes
• User Property: workingDirectory
• Default: ${project.build.directory}/checkout