release:prepare

Prepare for a release in SCM.

Mojo Attributes :

  • Requires a Maven 2.0 project to execute.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: test

Optional Parameters

Name Type Description
addSchema boolean Whether to add a schema to the POM if it was previously missing on release. Default value is true.
allowTimestampedSnapshots boolean Whether to timestamped SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT. Default value is false.
arguments String Additional arguments to pass to the Maven executions, separated by spaces.
autoVersionSubmodules boolean 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.
commitByProject boolean Commits to do are atomic or by project. Default value is false.
dryRun boolean 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 Whether to generate release-pom.xml files that contain resolved information about the project. Default value is false.
password String The SCM password to use.
pomFileName String The file name of the POM to execute any goals against.
preparationGoals String Goals to run as part of the preparation step, after transformation but before committing. Space delimited. Default value is clean verify.
providerImplementations Map List of provider implementations.
releaseManager ReleaseManager No description.
resume boolean Resume a previous release attempt from the point that it was stopped. Default value is true.
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.
updateDependencies boolean Whether to update dependencies version to the next development version. Default value is true.
useEditMode boolean Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations. Default value is false.
username String The SCM username to use.

Parameter Details

addSchema

Whether to add a schema to the POM if it was previously missing on release.

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

allowTimestampedSnapshots

Whether to timestamped SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT.

  • Type : boolean
  • Required : No
  • Expression : ${ignoreSnapshots}
  • Default : false

arguments

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

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

autoVersionSubmodules

Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the version of each submodules.

  • Type : boolean
  • Required : No
  • Expression : ${autoVersionSubmodules}
  • Default : false

commitByProject

Commits to do are atomic or by project.

  • Type : boolean
  • Required : No
  • Expression : ${commitByProject}
  • Default : false

dryRun

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.

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

generateReleasePoms

Whether to generate release-pom.xml files that contain resolved information about the project.

  • Type : boolean
  • Required : No
  • Expression : ${generateReleasePoms}
  • Default : false

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}

preparationGoals

Goals to run as part of the preparation step, after transformation but before committing. Space delimited.

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

providerImplementations

List of provider implementations.

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

releaseManager

No Description.

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

resume

Resume a previous release attempt from the point that it was stopped.

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

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}

updateDependencies

Whether to update dependencies version to the next development version.

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

useEditMode

Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations.

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

username

The SCM username to use.

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