release:branch

Branch a project in SCM.

Mojo Attributes :

  • Requires a Maven 2.0 project to execute.
  • Executes as an aggregator plugin.

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.
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.
branchName String The branch name to use.
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.
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.
updateBranchVersions boolean Whether to update versions in the branch. Default value is false.
updateDependencies boolean Whether to update dependencies version to the next development version. Default value is true.
updateVersionsToSnapshot boolean Whether to update versions to SNAPSHOT in the branch. Default value is true.
updateWorkingCopyVersions boolean Whether to update versions in the working copy. 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

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

branchName

The branch name to use.

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

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

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}

updateBranchVersions

Whether to update versions in the branch.

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

updateDependencies

Whether to update dependencies version to the next development version.

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

updateVersionsToSnapshot

Whether to update versions to SNAPSHOT in the branch.

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

updateWorkingCopyVersions

Whether to update versions in the working copy.

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