Full name:
org.apache.maven.plugins:maven-release-plugin:2.3.1:prepare-with-pom
Description:
Attributes:
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 | A list of additional exclude filters that will be 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 | 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. |
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.
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:
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. |
tag: