Optional Parameters

Name	Type	Since	Description
addSchema	boolean	2.0	Whether to add a schema to the POM if it was previously missing on release. Default value is: true.
allowTimestampedSnapshots	boolean	2.0-beta-7	Whether to allow timestamped SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT. Default value is: false.
arguments	String	2.0	Additional arguments to pass to the Maven executions, separated by spaces.
autoVersionSubmodules	boolean	2.0-beta-5	Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the version of each submodules. Default value is: false.
checkModificationExcludeList	String	2.1	Command-line version of checkModificationExcludes
checkModificationExcludes	String[]	2.1	Additional files that will skipped when checking for modifications on the working copy. Is ignored, when checkModificationExcludes is set.
commitByProject	boolean	2.0-beta-5	Commits to do are atomic or by project. Default value is: false.
completionGoals	String	2.2	Goals to run on completion of the preparation step, after transformation back to the next development version but before committing. Space delimited.
developmentVersion	String	2.0-beta-8	Default version to use for new local working copy.
dryRun	boolean	2.0	Dry run: don't checkin or tag anything in the scm repository, or modify the checkout. Running mvn -DdryRun=true release:prepare is useful in order to check that modifications to poms and scm operations (only listed on the console) are working as expected. Modified POMs are written alongside the originals without modifying them. Default value is: false.
generateReleasePoms	boolean	2.0	Whether to generate release-pom.xml files that contain resolved information about the project. Default value is: true.
javaHome	File	2.0-beta-8	The JAVA_HOME parameter to use for forked Maven invocations. Default value is: ${java.home}.
localCheckout	boolean	2.0	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 like e.g. git, jgit or hg! TODO: we should think about having the defaults for the various SCM providers provided via modello! Default value is: false.
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.
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	The SCM password to use.
pomFileName	String	2.0	The file name of the POM to execute any goals against.
preparationGoals	String	2.0	Goals to run as part of the preparation step, after transformation but before committing. Space delimited. Default value is: clean verify.
providerImplementations	Map	2.0-beta-6	List of provider implementations.
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.
releaseVersion	String	2.0-beta-8	Default version to use when preparing a release or a branch.
remoteTagging	boolean	2.0-beta-9	Currently only implemented with svn scm. Enables a workaround to prevent issue due to svn client > 1.5.0 (fixed in 1.6.5) (http://jira.codehaus.org/browse/SCM-406) You may not want to use this in conjunction with suppressCommitBeforeTag, such that no poms with released versions are committed to the working copy ever. Default value is: true.
resume	boolean	2.0	Resume a previous release attempt from the point where it was stopped. Default value is: true.
scmCommentPrefix	String	2.0-beta-5	The message prefix to use for all SCM changes. Default value is: [maven-release-plugin] .
suppressCommitBeforeTag	boolean	2.1	Whether to suppress a commit of changes to the working copy before the tag is created. This requires remoteTagging to be set to false. suppressCommitBeforeTag is useful when you want to avoid poms with released versions in all revisions of your trunk or development branch. Default value is: false.
tag	String	2.0	The SCM tag to use.
tagBase	String	2.0	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.
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}.
updateDependencies	boolean	2.0-beta-5	Whether to update dependencies version to the next development version. Default value is: true.
updateWorkingCopyVersions	boolean	2.1	Whether to bump the working copy versions to developmentVersion. Default value is: true.
useEditMode	boolean	2.0	Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations. Default value is: false.
username	String	2.0	The SCM username to use.
waitBeforeTagging	int	2.2	Wait the specified number of second before creating the tag. waitBeforeTagging is useful when your source repository is synced between several instances and access to it is determined by geographical location, like the SVN repository at the Apache Software Foundation. Default value is: 0.

Parameter Details

addSchema:

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${addSchema}
• Default: true

---

allowTimestampedSnapshots:

• Type: boolean
• Since: 2.0-beta-7
• Required: No
• Expression: ${ignoreSnapshots}
• Default: false

---

arguments:

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

---

autoVersionSubmodules:

• Type: boolean
• Since: 2.0-beta-5
• Required: No
• Expression: ${autoVersionSubmodules}
• Default: false

---

checkModificationExcludeList:

• Type: java.lang.String
• Since: 2.1
• Required: No
• Expression: ${checkModificationExcludeList}

---

checkModificationExcludes:

• Type: java.lang.String[]
• Since: 2.1
• Required: No

---

commitByProject:

• Type: boolean
• Since: 2.0-beta-5
• Required: No
• Expression: ${commitByProject}
• Default: false

---

completionGoals:

• Type: java.lang.String
• Since: 2.2
• Required: No
• Expression: ${completionGoals}

---

developmentVersion:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• Expression: ${developmentVersion}

---

dryRun:

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${dryRun}
• Default: false

---

generateReleasePoms:

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${generateReleasePoms}
• Default: true

---

javaHome:

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

---

localCheckout:

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${localCheckout}
• Default: false

---

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
• Expression: ${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
• Required: No
• Expression: ${password}

---

pomFileName:

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

---

preparationGoals:

• Type: java.lang.String
• Since: 2.0
• Required: No
• Expression: ${preparationGoals}
• Default: clean verify

---

providerImplementations:

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

---

pushChanges:

• Type: boolean
• Since: 2.1
• Required: No
• Expression: ${pushChanges}
• Default: true

---

releaseVersion:

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• Expression: ${releaseVersion}

---

remoteTagging:

• Type: boolean
• Since: 2.0-beta-9
• Required: No
• Expression: ${remoteTagging}
• Default: true

---

resume:

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${resume}
• Default: true

---

scmCommentPrefix:

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

---

suppressCommitBeforeTag:

• Type: boolean
• Since: 2.1
• Required: No
• Expression: ${suppressCommitBeforeTag}
• Default: false

---

tag:

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

---

tagBase:

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

---

tagNameFormat:

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

---

updateDependencies:

• Type: boolean
• Since: 2.0-beta-5
• Required: No
• Expression: ${updateDependencies}
• Default: true

---

updateWorkingCopyVersions:

• Type: boolean
• Since: 2.1
• Required: No
• Expression: ${updateWorkingCopyVersions}
• Default: true

---

useEditMode:

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${useEditMode}
• Default: false

---

username:

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

---

waitBeforeTagging:

• Type: int
• Since: 2.2
• Required: No
• Expression: ${waitBeforeTagging}
• Default: 0