Maven Release plugin – release:prepare (original) (raw)

Prepare for a release in SCM. Steps through several phases to ensure the POM is ready to be released and then prepares SCM to eventually contain a tagged version of the release and a record in the local copy of the parameters used. This can be followed by a call to release:perform. For more info see https://maven.apache.org/plugins/maven-release-plugin/usage/prepare-release.html.

Parameter Details

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

• Type: boolean
• Required: No
• User Property: addSchema
• Default: true

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

• Type: boolean
• Since: 2.0-beta-7
• Required: No
• User Property: ignoreSnapshots
• Default: false

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

• Type: java.lang.String
• Required: No
• User Property: arguments
• Alias: prepareVerifyArgs

Specifies whether unresolved SNAPSHOT dependencies should automatically be resolved. If this is set, then this specifies the default answer to be used when unresolved SNAPSHOT dependencies should automatically be resolved ( 0:All 1:Project Dependencies 2:Plugins 3:Reports 4:Extensions ). Possible values are:

• "all" or "0": resolve all kinds of snapshots, ie. project, plugin, report and extension dependencies

• "dependencies" or "1": resolve project dependencies

• "plugins" or "2": resolve plugin dependencis

• "reports" or "3": resolve report dependencies

• "extensions" or "4": resolve extension dependencies

• Type: java.lang.String

• Since: 3.0.0-M4

• Required: No

• User Property: autoResolveSnapshots

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
• Since: 2.0-beta-5
• Required: No
• User Property: autoVersionSubmodules
• Default: false

Command-line version of checkModificationExcludes.

• Type: java.lang.String
• Since: 2.1
• Required: No
• User Property: checkModificationExcludeList

A list of additional exclude filters that will be skipped when checking for modifications on the working copy. Is ignored, when checkModificationExcludes is set.

• Type: java.lang.String[]
• Since: 2.1
• Required: No

Commits to do are atomic or by project.

• Type: boolean
• Since: 2.0-beta-5
• Required: No
• User Property: commitByProject
• Default: false

Goals to run on completion of the preparation step, after transformation back to the next development version but before committing. Space delimited.

• Type: java.lang.String
• Since: 2.2
• Required: No
• User Property: completionGoals

Default version to use for new local working copy.

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: developmentVersion

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
• User Property: dryRun
• Default: false

Deprecated.
Please use release:prepare-with-pom instead.

No description.

• Type: boolean
• Required: No
• User Property: generateReleasePoms
• Default: false

The Java home parameter to use for forked Maven invocations.

• Type: java.io.File
• Since: 2.0-beta-8
• Required: No
• Default: ${java.home}

Specifies the line separator to format pom.xml. The following properties are available:

• system - Use the system line separator.

• lf - Use \n as line separator.

• cr - Use \r as line separator.

• crlf - Use \r\n as line separator.

• source - Use the same line separator as it is specified in the current pom.xml.

• Type: java.lang.String

• Since: 3.0.0-M6

• Required: No

• User Property: lineSeparator

• Default: source

The command-line local repository directory in use for this build (if specified).

• Type: java.io.File
• Since: 2.0-beta-8
• Required: No
• Default: ${maven.repo.local}

Role hint of the org.apache.maven.shared.release.exec.MavenExecutor

implementation to use.

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: mavenExecutorId
• Default: invoker

The Maven home parameter to use for forked Maven invocations.

• Type: java.io.File
• Since: 2.0-beta-8
• Required: No
• Default: ${maven.home}

The SCM password to use.

• Type: java.lang.String
• Required: No
• User Property: password

Currently only implemented with svn scm. Enable the --pin-externals option in svn copy command which is new in Subversion 1.9.

• Type: boolean
• Since: 3.0.0-M4
• Required: No
• User Property: pinExternals
• Default: false

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.

• Type: java.lang.String
• Required: No
• User Property: pomFileName
• Default: ${project.file.name}

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

• Type: java.lang.String
• Required: No
• User Property: preparationGoals
• Default: clean verify

Comma separated profiles to enable on release prepare, in addition to active profiles for project execution.

• Type: java.lang.String
• Since: 3.0.0
• Required: No
• User Property: preparationProfiles

The role-hint for the org.apache.maven.shared.release.policy.naming.NamingPolicy

implementation used to calculate the project branch and tag names.
See also: org.apache.maven.shared.release.policies.DefaultNamingPolicy

• Type: java.lang.String
• Since: 3.0.0-M1
• Required: No
• User Property: projectNamingPolicyId

Optional config for the VersionPolicy implementation used to calculate the project versions.

• Type: org.codehaus.plexus.configuration.PlexusConfiguration
• Since: 3.0.0
• Required: No
• User Property: projectVersionPolicyConfig

The role-hint for the org.apache.maven.shared.release.policy.version.VersionPolicy

implementation used to calculate the project versions.
See also: org.apache.maven.shared.release.policies.DefaultVersionPolicy

• Type: java.lang.String
• Since: 2.5.1
• Required: No
• User Property: projectVersionPolicyId
• Default: default

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 org.apache.maven.scm.provider.ScmProvider

.
See also: org.apache.maven.scm.manager.ScmManager.setScmProviderImplementation(java.lang.String,java.lang.String)

• Type: java.util.Map<java.lang.String, java.lang.String>
• Since: 2.0-beta-6
• Required: No

Implemented with git will or not push changes to the upstream repository. true by default to preserve backward compatibility.

• Type: boolean
• Since: 2.1
• Required: No
• User Property: pushChanges
• Default: true

The role-hint for the org.apache.maven.shared.release.strategy.Strategy

implementation used to specify the phases per goal.
See also: org.apache.maven.shared.release.strategies.DefaultStrategy

• Type: java.lang.String
• Since: 3.0.0-M5
• Required: No
• User Property: releaseStrategyId
• Default: default

Default version to use when preparing a release or a branch.

• Type: java.lang.String
• Since: 2.0-beta-8
• Required: No
• User Property: releaseVersion

Currently only implemented with svn scm.

• Enables a workaround to prevent issue due to svn client > 1.5.0 (fixed in 1.6.5) (https://issues.apache.org/jira/browse/SCM-406)

• You may not want to use this in conjunction with suppressCommitBeforeTag, such that no poms with released versions are committed to the working copy ever.

• Type: boolean

• Since: 2.0-beta-9

• Required: No

• User Property: remoteTagging

• Default: true

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

• Type: boolean
• Required: No
• User Property: resume
• Default: true

The message prefix to use for all SCM changes.

• Type: java.lang.String
• Since: 2.0-beta-5
• Required: No
• User Property: scmCommentPrefix
• Default: [maven-release-plugin]

The SCM commit comment when setting pom.xml back to development. Defaults to "@{prefix} prepare for next development iteration".

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:

• prefix - The comment prefix.

• groupId - The groupId of the root project.

• artifactId - The artifactId of the root project.

• releaseLabel - The release version of the root project.

• Type: java.lang.String

• Since: 3.0.0-M1

• Required: No

• User Property: scmDevelopmentCommitComment

• Default: @{prefix} prepare for next development iteration

The SCM commit comment when setting pom.xml to release. Defaults to "@{prefix} prepare release @{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:

• prefix - The comment prefix.

• groupId - The groupId of the root project.

• artifactId - The artifactId of the root project.

• releaseLabel - The release version of the root project.

• Type: java.lang.String

• Since: 3.0.0-M1

• Required: No

• User Property: scmReleaseCommitComment

• Default: @{prefix} prepare release @{releaseLabel}

When cloning a repository if it should be a shallow clone or a full clone.

• Type: boolean
• Required: No
• User Property: scmShallowClone
• Default: true

Signs SCM tag when possible, for example when using the git-exe the '--sign' argument is used.

• Type: boolean
• Since: 3.0.0-M4
• Required: No
• User Property: signTag

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.

• Type: boolean
• Since: 2.1
• Required: No
• User Property: suppressCommitBeforeTag
• Default: false

The SCM tag to use.

• Type: java.lang.String
• Required: No
• User Property: tag
• Alias: releaseLabel

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
• User Property: tagBase

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: 2.2.0

• Required: No

• User Property: tagNameFormat

• Default: @{project.artifactId}-@{project.version}

Whether to update dependencies version to the next development version.

• Type: boolean
• Since: 2.0-beta-5
• Required: No
• User Property: updateDependencies
• Default: true

Whether to bump the working copy versions to developmentVersion.

• Type: boolean
• Since: 2.1
• Required: No
• User Property: updateWorkingCopyVersions
• Default: true

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

• Type: boolean
• Required: No
• User Property: useEditMode
• Default: false

The SCM username to use.

• Type: java.lang.String
• Required: No
• User Property: username

Wait the specified number of seconds 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.

• Type: int
• Since: 2.2
• Required: No
• User Property: waitBeforeTagging
• Default: 0

A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.

• Type: java.lang.String
• Since: 3.0.0-M5
• Required: No
• User Property: workItem