Full name:
org.apache.maven.plugins:maven-release-plugin:3.0.0-M4:branch
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
<addSchema> | boolean | 2.0-beta-6 | Whether to add a schema to the POM if it was previously missing on
release. Default value is: true. User property is: addSchema. |
<arguments> | String | 2.0-beta-6 | Additional arguments to pass to the Maven executions, separated by
spaces. User property is: arguments. Alias is: prepareVerifyArgs. |
<autoVersionSubmodules> | boolean | 2.0-beta-6 | 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. User property is: autoVersionSubmodules. |
<branchBase> | String | 2.0 | The branch 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/branches.
The URL is an SVN URL and does not include the SCM provider and
protocol. User property is: branchBase. |
<branchName> | String | 2.0-beta-6 | The branch name to use. User property is: branchName. |
<checkModificationExcludeList> | String | 2.1 | Command-line version of checkModificationExcludes. User property is: checkModificationExcludeList. |
<checkModificationExcludes> | String[] | 2.1 | A list of additional exclude filters that will be skipped when
checking for modifications on the working copy. Is ignored, when
checkModificationExcludes is set. |
<developmentVersion> | String | 2.0 | Specify the new version for the working copy. This parameter is
only meaningful if updateWorkingCopyVersions =
true. User property is: developmentVersion. |
<dryRun> | boolean | 2.0-beta-6 | 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. User property is: dryRun. |
<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-6 | The SCM password to use. User property is: password. |
<pinExternals> | boolean | 3.0.0 | Currently only implemented with svn scm. Enable the
--pin-externals option in svn copy
command which is new in Subversion 1.9. Default value is: false. User property is: pinExternals. |
<pomFileName> | String | 2.0-beta-6 | The file name of the POM to execute any goals against. As of
version 3.0.0, this defaults to the name of POM file of the project
being built. Default value is: ${project.file.name}. User property is: pomFileName. |
<projectBranchNamingPolicyId> | String | 3.0.0 | The role-hint for the NamingPolicy implementation used
to calculate the project names. User property is: projectNamingPolicyId. |
<projectVersionPolicyId> | String | 3.0.0 | The role-hint for the VersionPolicy implementation
used to calculate the project versions. Default value is: default. User property is: projectVersionPolicyId. |
<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. |
<releaseStrategyId> | String | 3.0.0 | The role-hint for the Strategy implementation used to
specify the phases per goal. Default value is: default. User property is: releaseStrategyId. |
<releaseVersion> | String | 2.0 | Specify the new version for the branch. This parameter is only
meaningful if updateBranchVersions =
true. User property is: releaseVersion. |
<remoteTagging> | boolean | 2.0 | currently only implemented with svn scm. Enable a workaround to
prevent issue due to svn client > 1.5.0
(https://issues.apache.org/jira/browse/SCM-406) Default value is: true. User property is: remoteTagging. |
<scmBranchCommitComment> | String | 3.0.0-M1 | The SCM commit comment when branching. Defaults to "@{prefix}
prepare branch @{releaseLabel}".
Property interpolation is performed on the value, 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:
Default value is: @{prefix} prepare branch @{releaseLabel}. User property is: scmBranchCommitComment. |
<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. |
<suppressCommitBeforeBranch> | 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. suppressCommitBeforeBranch is useful when you want to avoid poms with released versions in all revisions of your trunk or development branch. Default value is: false. User property is: suppressCommitBeforeBranch. |
<tag> | String | 2.0-beta-6 | The SCM tag to use. User property is: tag. Alias is: releaseLabel. |
<tagBase> | String | 2.0-beta-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 | 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:
Default value is: @{project.artifactId}-@{project.version}. User property is: tagNameFormat. |
<updateBranchVersions> | boolean | 2.0-beta-6 | Whether to update versions in the branch. Default value is: false. User property is: updateBranchVersions. |
<updateDependencies> | boolean | 2.0-beta-6 | Whether to update dependencies version to the next development
version. Default value is: true. User property is: updateDependencies. |
<updateVersionsToSnapshot> | boolean | 2.0-beta-6 | Whether to update versions to SNAPSHOT in the branch. Default value is: true. User property is: updateVersionsToSnapshot. |
<updateWorkingCopyVersions> | boolean | 2.0-beta-6 | Whether to update versions in the working copy. Default value is: true. User property is: updateWorkingCopyVersions. |
<useEditMode> | boolean | 2.0-beta-6 | Whether to use "edit" mode on the SCM, to lock the file for editing
during SCM operations. Default value is: false. User property is: useEditMode. |
<username> | String | 2.0-beta-6 | The SCM username to use. User property is: username. |
<workItem> | String | 3.0.0 | A workItem for SCMs like RTC, TFS etc, that may require additional
information to perform a pushChange operation. User property is: workItem. |
Property interpolation is performed on the value, 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: