cxx:release

Full name:

org.codehaus.mojo:cxx-maven-plugin:0.0.6-SNAPSHOT:release

Description:

Branch a project in SCM

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Since version: 0.0.6.

Required Parameters

Name Type Since Description
workingDirectory File 0.0.6 The checkout directory.
Default value is: ${project.build.directory}/checkout.
User property is: workingDirectory.

Optional Parameters

Name Type Since Description
addSchema boolean 0.0.6 Whether to add a XML schema to the POM if it was previously missing on.
Default value is: true.
User property is: addSchema.
artifactId String 0.0.6 new artifact id, if provided
User property is: artifactId.
autoVersionSubmodules boolean 0.0.6 Whether to automatically assign submodules the parent (main) version. If set to true, each submodule (if any) will be update to computed main version If set to false : - the user will be prompted for each submodules version if settings.isInteractiveMode()/-B,--batch-mode flag not set - auto-computed if !settings.isInteractiveMode()/-B,--batch-mode flag set !!PLUS!! : Submodule version are updated only if they are "real" child of main module, according to SCM tree. Aka. Only and only if : - submodule dir is under scm configuration - submodule dir is not an external dir - (futur ?) submodule dir is an external dir AND settings.isInteractiveMode()/-B,--batch-mode flag not set AND user confirm branch and version update
Default value is: false.
User property is: autoVersionSubmodules.
developmentVersion String 0.0.6 Specify the new version for the working copy. This parameter is only meaningful if updateWorkingCopyVersions = true.
User property is: developmentVersion.
dryRun boolean 0.0.6 Dry run: don't checkin or tag anything in the scm repository, or modify the checkout. Running mvn -DdryRun=true cxx:branch 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.
User property is: dryRun.
javaHome File 0.0.6 The JAVA_HOME parameter to use for forked Maven invocations.
Default value is: ${java.home}.
localRepoDirectory File 0.0.6 The command-line local repository directory in use for this build (if specified).
Default value is: ${maven.repo.local}.
mavenHome File 0.0.6 The M2_HOME parameter to use for forked Maven invocations.
Default value is: ${maven.home}.
password String 0.0.6 The user password (used by svn). You may use maven setting to store encrypted password. See http://maven.apache.org/guides/mini/guide-encryption.html
User property is: password.
releaseLabel String 0.0.6 The SCM tag to use.
User property is: releaseLabel.
releaseVersion String 0.0.6 Default version to use when preparing a release.
User property is: releaseVersion.
settingsServerId String 0.0.6 The server id to use in maven settings to retrieve credential. Optionnal, by defaut each scm url "hostname[:port]" is taken as server id to search potential credentials in maven settings See http://maven.apache.org/guides/mini/guide-encryption.html
User property is: settingsServerId.
snapshotDevelopmentVersion boolean 0.0.6 Shall developpment version use -SNAPSHOT suffix
Default value is: false.
User property is: snapshotDevelopmentVersion.
tagBase String 0.0.6 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 0.0.6 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.
updateDependencies boolean 0.0.6 Whether to update dependencies version to the next development version.
Default value is: true.
User property is: updateDependencies.
updateWorkingCopyVersions boolean 0.0.6 Whether to update versions in the working copy.
Default value is: true.
User property is: updateWorkingCopyVersions.
username String 0.0.6 The user name (used by svn). You may use maven setting to store username. See http://maven.apache.org/guides/mini/guide-encryption.html
User property is: username.

Parameter Details

addSchema:

Whether to add a XML schema to the POM if it was previously missing on.
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: addSchema
  • Default: true

artifactId:

new artifact id, if provided
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: artifactId

autoVersionSubmodules:

Whether to automatically assign submodules the parent (main) version. If set to true, each submodule (if any) will be update to computed main version If set to false : - the user will be prompted for each submodules version if settings.isInteractiveMode()/-B,--batch-mode flag not set - auto-computed if !settings.isInteractiveMode()/-B,--batch-mode flag set !!PLUS!! : Submodule version are updated only if they are "real" child of main module, according to SCM tree. Aka. Only and only if : - submodule dir is under scm configuration - submodule dir is not an external dir - (futur ?) submodule dir is an external dir AND settings.isInteractiveMode()/-B,--batch-mode flag not set AND user confirm branch and version update
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: autoVersionSubmodules
  • Default: false

developmentVersion:

Specify the new version for the working copy. This parameter is only meaningful if updateWorkingCopyVersions = true.
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: developmentVersion

dryRun:

Dry run: don't checkin or tag anything in the scm repository, or modify the checkout. Running mvn -DdryRun=true cxx:branch 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
  • Since: 0.0.6
  • Required: No
  • User Property: dryRun
  • Default: false

javaHome:

The JAVA_HOME parameter to use for forked Maven invocations.
  • Type: java.io.File
  • Since: 0.0.6
  • Required: No
  • Default: ${java.home}

localRepoDirectory:

The command-line local repository directory in use for this build (if specified).
  • Type: java.io.File
  • Since: 0.0.6
  • Required: No
  • Default: ${maven.repo.local}

mavenHome:

The M2_HOME parameter to use for forked Maven invocations.
  • Type: java.io.File
  • Since: 0.0.6
  • Required: No
  • Default: ${maven.home}

password:

The user password (used by svn). You may use maven setting to store encrypted password. See http://maven.apache.org/guides/mini/guide-encryption.html
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: password

releaseLabel:

The SCM tag to use.
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: releaseLabel

releaseVersion:

Default version to use when preparing a release.
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: releaseVersion

settingsServerId:

The server id to use in maven settings to retrieve credential. Optionnal, by defaut each scm url "hostname[:port]" is taken as server id to search potential credentials in maven settings See http://maven.apache.org/guides/mini/guide-encryption.html
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: settingsServerId

snapshotDevelopmentVersion:

Shall developpment version use -SNAPSHOT suffix
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: snapshotDevelopmentVersion
  • Default: false

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
  • Since: 0.0.6
  • Required: No
  • User Property: tagBase

tagNameFormat:

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.
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: tagNameFormat
  • Default: @{project.artifactId}-@{project.version}

updateDependencies:

Whether to update dependencies version to the next development version.
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: updateDependencies
  • Default: true

updateWorkingCopyVersions:

Whether to update versions in the working copy.
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: updateWorkingCopyVersions
  • Default: true

username:

The user name (used by svn). You may use maven setting to store username. See http://maven.apache.org/guides/mini/guide-encryption.html
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: username

workingDirectory:

The checkout directory.
  • Type: java.io.File
  • Since: 0.0.6
  • Required: Yes
  • User Property: workingDirectory
  • Default: ${project.build.directory}/checkout