Class ModelloReleaseDescriptor
java.lang.Object
org.apache.maven.shared.release.config.ModelloReleaseDescriptor
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ReleaseDescriptorBuilder.BuilderReleaseDescriptor
Class ModelloReleaseDescriptor.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionField activateProfiles.private String
Additional arguments to pass to any executed Maven process.private boolean
Whether to add the model schema to the top of the rewritten POM if it wasn't there already.private boolean
Should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.private boolean
Whether to use the parent pom version for submodule versions.private boolean
Whether to create a branch instead of do a release.Field checkModificationExcludes.private String
The directory where the tag will be checked out.private boolean
The commits must be done by modules or not.private String
The last completed phase.private String
The goals to execute in on completion of preparation for the release.private String
Default version to use for new working copy.private String
Default version to use for the tagged release or the new branch.private String
The description of this release configuration .private boolean
Whether to generate release POMs.private boolean
Whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.private boolean
If the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network.private String
Field modelEncoding.private String
The name of this release configuration .Field originalScmInfo.private String
The goals to execute in perform phase for the release.private String
The file name of the POM to pass to any executed Maven process.private String
The goals to execute in preparation for the release.private String
The role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.private String
The role-hint for the VersionPolicy implementation used to calculate the project versions.private Map
<String, ReleaseStageVersions> Field projectVersionsprivate boolean
Should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository.private String
The role-hint for the release Strategy implementation.private boolean
NOTE : currently only implemented with svn scm.private Map
<String, ReleaseStageVersions> Field resolvedSnapshotDependencies.private String
Where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches .private String
The SCM commit comment when branching .private String
The prefix of SCM modification messages .private String
The SCM commit comment when setting pom.xml back to development .private String
The id can be used to get the credentials by the server-id from the settings.xml .private String
The password for the user interacting with the scm .private String
Private key for an SSH based SCM repository.private String
Pass phrase for the private key.private String
Relative path of the project returned by the checkout command.private String
The SCM commit comment when setting pom.xml to release .private String
NOTE : currently only implemented with svn scm.private String
tag or branch name: the identifier for the tag/branch.private String
The SCM commit comment when rolling back .private String
This is a MavenSCM of where you're going to get the sources to make the release with.private String
Where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags .private String
Specifies the format for generating a tag name.private boolean
Whether to use edit mode when making SCM modifications.private String
The user name to interact with the scm .private boolean
Whether a SNAPSHOT of the release plugin is allowed.private boolean
Whether to suppress a commit of changes to the working copy before a tag or branch is created.private boolean
Whether to update branch POM versions.private boolean
If updateDependencies is false, dependencies version won't be updated to the next development version.private boolean
Whether to update branch versions to SNAPSHOT.private boolean
Whether to update working copy POM versions.private boolean
Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.private int
Wait the specified number of seconds before creating a tag.private String
The directory where the release is performed.private String
Some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addActivateProfile
(String string) Method addActivateProfile.void
addCheckModificationExclude
(String string) Method addCheckModificationExclude.void
addDependencyDevelopmentVersion
(String dependencyKey, String version) void
addDependencyOriginalVersion
(String dependencyKey, String version) void
addDependencyReleaseVersion
(String dependencyKey, String version) void
addDevelopmentVersion
(String projectId, String version) Method addDevelopmentVersion.void
addOriginalScmInfo
(String key, org.apache.maven.model.Scm value) Method addOriginalScmInfo.void
addOriginalVersion
(String projectId, String version) void
addReleaseVersion
(String projectId, String version) Method addReleaseVersion.private boolean
compareScmCollections
(Map<String, org.apache.maven.model.Scm> that) private static ReleaseStageVersions
computeIfAbsent
(Map<String, ReleaseStageVersions> map, String key) boolean
Method getActivateProfiles.Get additional arguments to pass to any executed Maven process.Method getCheckModificationExcludes.Get the directory where the tag will be checked out.Get the last completed phase.Get the goals to execute in on completion of preparation for the release.Get default version to use for new working copy.Get default version to use for the tagged release or the new branch.getDependencyDevelopmentVersion
(String artifactConflictId) Retrieve the release version for the resolved snapshot dependency.getDependencyOriginalVersion
(String artifactConflictId) Retrieve the original version for the resolved snapshot dependency.getDependencyReleaseVersion
(String artifactConflictId) Retrieve the release version for the resolved snapshot dependency.Get the description of this release configuration.Get the modelEncoding field.getName()
Get the name of this release configuration.org.apache.maven.model.Scm
Method getOriginalScmInfo.Get the goals to execute in perform phase for the release.Get the file name of the POM to pass to any executed Maven process.Get the goals to execute in preparation for the release.getProjectDevelopmentVersion
(String projectId) Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.getProjectOriginalVersion
(String projectId) getProjectReleaseVersion
(String projectId) Get the role-hint for the VersionPolicy implementation used to calculate the project versions.(package private) Map
<String, ReleaseStageVersions> Get the role-hint for the release Strategy implementation.(package private) Map
<String, ReleaseStageVersions> Method getResolvedSnapshotDependencies.Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.Get the SCM commit comment when branching.Get the prefix of SCM modification messages.Get the SCM commit comment when setting pom.xml back to development.getScmId()
Get the id can be used to get the credentials by the server-id from the settings.xml.Get the password for the user interacting with the scm.Get private key for an SSH based SCM repository.Get pass phrase for the private key.Get relative path of the project returned by the checkout command.Get the SCM commit comment when setting pom.xml to release.Get nOTE : currently only implemented with svn scm.Get tag or branch name: the identifier for the tag/branch.Get the SCM commit comment when rolling back.Get this is a MavenSCM of where you're going to get the sources to make the release with.Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.Get specifies the format for generating a tag name.Get the user name to interact with the scm.int
Get wait the specified number of seconds before creating a tag.Get the directory where the release is performed.Get some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered.int
hashCode()
boolean
Get whether to add the model schema to the top of the rewritten POM if it wasn't there already.boolean
Get should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.boolean
Get whether to use the parent pom version for submodule versions.boolean
Get whether to create a branch instead of do a release.boolean
Get the commits must be done by modules or not.boolean
Get whether to generate release POMs.boolean
Get whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.boolean
Get if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network.boolean
Get should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository.boolean
Get nOTE : currently only implemented with svn scm.boolean
Get whether to use edit mode when making SCM modifications.boolean
Get whether a SNAPSHOT of the release plugin is allowed.boolean
Get whether to suppress a commit of changes to the working copy before a tag or branch is created.boolean
Get whether to update branch POM versions.boolean
Get if updateDependencies is false, dependencies version won't be updated to the next development version.boolean
Get whether to update branch versions to SNAPSHOT.boolean
Get whether to update working copy POM versions.boolean
Get whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.void
removeActivateProfile
(String string) Method removeActivateProfile.void
removeCheckModificationExclude
(String string) Method removeCheckModificationExclude.void
setActivateProfiles
(List<String> activateProfiles) Set list of profiles to activate.void
setAdditionalArguments
(String additionalArguments) Set additional arguments to pass to any executed Maven process.void
setAddSchema
(boolean addSchema) Set whether to add the model schema to the top of the rewritten POM if it wasn't there already.void
setAllowTimestampedSnapshots
(boolean allowTimestampedSnapshots) Set should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.void
setAutoVersionSubmodules
(boolean autoVersionSubmodules) Set whether to use the parent pom version for submodule versions.void
setBranchCreation
(boolean branchCreation) Set whether to create a branch instead of do a release.void
setCheckModificationExcludes
(List<String> checkModificationExcludes) Set in some exceptions you want to allow changes to the working copy.void
setCheckoutDirectory
(String checkoutDirectory) Set the directory where the tag will be checked out.void
setCommitByProject
(boolean commitByProject) Set the commits must be done by modules or not.void
setCompletedPhase
(String completedPhase) Set the last completed phase.void
setCompletionGoals
(String completionGoals) Set the goals to execute in on completion of preparation for the release.void
setDefaultDevelopmentVersion
(String defaultDevelopmentVersion) Set default version to use for new working copy.void
setDefaultReleaseVersion
(String defaultReleaseVersion) Set default version to use for the tagged release or the new branch.void
setDescription
(String description) Set the description of this release configuration.void
setGenerateReleasePoms
(boolean generateReleasePoms) Set whether to generate release POMs.void
setInteractive
(boolean interactive) Set whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.void
setLocalCheckout
(boolean localCheckout) Set if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network.void
setModelEncoding
(String modelEncoding) Set the modelEncoding field.void
Set the name of this release configuration.void
setPerformGoals
(String performGoals) Set the goals to execute in perform phase for the release.void
setPomFileName
(String pomFileName) Set the file name of the POM to pass to any executed Maven process.void
setPreparationGoals
(String preparationGoals) Set the goals to execute in preparation for the release.void
setProjectNamingPolicyId
(String projectNamingPolicyId) Set the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.void
setProjectVersionPolicyId
(String projectVersionPolicyId) Set the role-hint for the VersionPolicy implementation used to calculate the project versions.void
setPushChanges
(boolean pushChanges) Set should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository.void
setReleaseStrategyId
(String releaseStrategyId) Set the role-hint for the release Strategy implementation.void
setRemoteTagging
(boolean remoteTagging) Set nOTE : currently only implemented with svn scm.void
setScmBranchBase
(String scmBranchBase) Set where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.void
setScmBranchCommitComment
(String scmBranchCommitComment) Set the SCM commit comment when branching.void
setScmCommentPrefix
(String ScmCommentPrefix) Set the prefix of SCM modification messages.void
setScmDevelopmentCommitComment
(String scmDevelopmentCommitComment) Set the SCM commit comment when setting pom.xml back to development.void
Set the id can be used to get the credentials by the server-id from the settings.xml.void
setScmPassword
(String scmPassword) Set the password for the user interacting with the scm.void
setScmPrivateKey
(String scmPrivateKey) Set private key for an SSH based SCM repository.void
setScmPrivateKeyPassPhrase
(String scmPrivateKeyPassPhrase) Set pass phrase for the private key.void
setScmRelativePathProjectDirectory
(String scmRelativePathProjectDirectory) Set relative path of the project returned by the checkout command.void
setScmReleaseCommitComment
(String scmReleaseCommitComment) Set the SCM commit comment when setting pom.xml to release.void
setScmReleasedPomRevision
(String scmReleasedPomRevision) Set nOTE : currently only implemented with svn scm.void
setScmReleaseLabel
(String scmReleaseLabel) Set tag or branch name: the identifier for the tag/branch.void
setScmRollbackCommitComment
(String scmRollbackCommitComment) Set the SCM commit comment when rolling back.void
setScmSourceUrl
(String scmSourceUrl) Set this is a MavenSCM of where you're going to get the sources to make the release with.void
setScmTagBase
(String scmTagBase) Set where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.void
setScmTagNameFormat
(String scmTagNameFormat) Set specifies the format for generating a tag name.void
setScmUseEditMode
(boolean scmUseEditMode) Set whether to use edit mode when making SCM modifications.void
setScmUsername
(String scmUsername) Set the user name to interact with the scm.void
setSnapshotReleasePluginAllowed
(boolean snapshotReleasePluginAllowed) Set whether a SNAPSHOT of the release plugin is allowed.void
setSuppressCommitBeforeTagOrBranch
(boolean suppressCommitBeforeTagOrBranch) Set whether to suppress a commit of changes to the working copy before a tag or branch is created.void
setUpdateBranchVersions
(boolean updateBranchVersions) Set whether to update branch POM versions.void
setUpdateDependencies
(boolean updateDependencies) Set if updateDependencies is false, dependencies version won't be updated to the next development version.void
setUpdateVersionsToSnapshot
(boolean updateVersionsToSnapshot) Set whether to update branch versions to SNAPSHOT.void
setUpdateWorkingCopyVersions
(boolean updateWorkingCopyVersions) Set whether to update working copy POM versions.void
setUseReleaseProfile
(boolean useReleaseProfile) Set whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.void
setWaitBeforeTagging
(int waitBeforeTagging) Set wait the specified number of seconds before creating a tag.void
setWorkingDirectory
(String workingDirectory) Set the directory where the release is performed.void
setWorkItem
(String workItem) Set some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered.
-
Field Details
-
name
The name of this release configuration . -
description
The description of this release configuration . -
ScmCommentPrefix
The prefix of SCM modification messages . -
scmReleaseCommitComment
The SCM commit comment when setting pom.xml to release . -
scmDevelopmentCommitComment
The SCM commit comment when setting pom.xml back to development . -
scmBranchCommitComment
The SCM commit comment when branching . -
scmRollbackCommitComment
The SCM commit comment when rolling back . -
scmSourceUrl
This is a MavenSCM of where you're going to get the sources to make the release with. Example: scm:svn:https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-release-plugin . -
scmTagBase
Where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags . -
scmBranchBase
Where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches . -
scmReleaseLabel
tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0 . -
scmId
The id can be used to get the credentials by the server-id from the settings.xml . -
scmUsername
The user name to interact with the scm . -
scmPassword
The password for the user interacting with the scm . -
scmPrivateKey
Private key for an SSH based SCM repository. -
scmPrivateKeyPassPhrase
Pass phrase for the private key. -
scmUseEditMode
private boolean scmUseEditModeWhether to use edit mode when making SCM modifications. This setting is disregarded if the SCM does not support edit mode, or if edit mode is compulsory for the given SCM. -
scmRelativePathProjectDirectory
Relative path of the project returned by the checkout command. -
updateDependencies
private boolean updateDependenciesIf updateDependencies is false, dependencies version won't be updated to the next development version. -
useReleaseProfile
private boolean useReleaseProfileWhether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, this will set the property "performRelease" to true. -
activateProfiles
Field activateProfiles. -
workingDirectory
The directory where the release is performed. -
checkoutDirectory
The directory where the tag will be checked out. -
completedPhase
The last completed phase. -
addSchema
private boolean addSchemaWhether to add the model schema to the top of the rewritten POM if it wasn't there already. Iffalse
then the root element will remain untouched. -
generateReleasePoms
private boolean generateReleasePomsWhether to generate release POMs. -
autoVersionSubmodules
private boolean autoVersionSubmodulesWhether to use the parent pom version for submodule versions. -
interactive
private boolean interactiveWhether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless. -
snapshotReleasePluginAllowed
private boolean snapshotReleasePluginAllowedWhether a SNAPSHOT of the release plugin is allowed. -
additionalArguments
Additional arguments to pass to any executed Maven process. -
pomFileName
The file name of the POM to pass to any executed Maven process. -
checkModificationExcludes
Field checkModificationExcludes. -
preparationGoals
The goals to execute in preparation for the release. -
completionGoals
The goals to execute in on completion of preparation for the release. -
performGoals
The goals to execute in perform phase for the release. -
commitByProject
private boolean commitByProjectThe commits must be done by modules or not. Set it to true in case of flat directory structure. -
branchCreation
private boolean branchCreationWhether to create a branch instead of do a release. -
updateBranchVersions
private boolean updateBranchVersionsWhether to update branch POM versions. -
updateWorkingCopyVersions
private boolean updateWorkingCopyVersionsWhether to update working copy POM versions. -
updateVersionsToSnapshot
private boolean updateVersionsToSnapshotWhether to update branch versions to SNAPSHOT. -
suppressCommitBeforeTagOrBranch
private boolean suppressCommitBeforeTagOrBranchWhether to suppress a commit of changes to the working copy before a tag or branch is created. -
waitBeforeTagging
private int waitBeforeTaggingWait the specified number of seconds before creating a tag. -
allowTimestampedSnapshots
private boolean allowTimestampedSnapshotsShould timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found. -
defaultReleaseVersion
Default version to use for the tagged release or the new branch. -
defaultDevelopmentVersion
Default version to use for new working copy. -
projectVersionPolicyId
The role-hint for the VersionPolicy implementation used to calculate the project versions. -
projectNamingPolicyId
The role-hint for the NamingPolicy implementation used to calculate the project branch and tag names. -
releaseStrategyId
The role-hint for the release Strategy implementation. -
remoteTagging
private boolean remoteTaggingNOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406) . -
scmReleasedPomRevision
NOTE : currently only implemented with svn scm. It contains the revision of the committed released pom to remotely tag the source code with this revision. -
pushChanges
private boolean pushChangesShould distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users. -
localCheckout
private boolean localCheckoutIf the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network. This is very helpful for releasing large projects! -
scmTagNameFormat
Specifies the format for generating a tag name. Property expansion is used with the optional prefix of project, where properties are delimited with @{ and } . -
workItem
Some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered. This field allows you to specify that Work Item or Task. It is optional, and only relevant if pushChanges is true. -
modelEncoding
Field modelEncoding. -
resolvedSnapshotDependencies
Field resolvedSnapshotDependencies. -
projectVersions
Field projectVersions -
originalScmInfo
Field originalScmInfo.
-
-
Constructor Details
-
ModelloReleaseDescriptor
public ModelloReleaseDescriptor()
-
-
Method Details
-
addActivateProfile
Method addActivateProfile.- Parameters:
string
- a string object.
-
addCheckModificationExclude
Method addCheckModificationExclude.- Parameters:
string
- a string object.
-
getActivateProfiles
Method getActivateProfiles.- Returns:
- List
-
getAdditionalArguments
Get additional arguments to pass to any executed Maven process.- Returns:
- String
-
getCheckModificationExcludes
Method getCheckModificationExcludes.- Returns:
- List
-
getCheckoutDirectory
Get the directory where the tag will be checked out.- Returns:
- String
-
getCompletedPhase
Get the last completed phase.- Returns:
- String
-
getCompletionGoals
Get the goals to execute in on completion of preparation for the release.- Returns:
- String
-
getDefaultDevelopmentVersion
Get default version to use for new working copy.- Returns:
- String
-
getDefaultReleaseVersion
Get default version to use for the tagged release or the new branch.- Returns:
- String
-
getDescription
Get the description of this release configuration.- Returns:
- String
-
getModelEncoding
Get the modelEncoding field.- Returns:
- String
-
getName
Get the name of this release configuration.- Returns:
- String
-
getPerformGoals
Get the goals to execute in perform phase for the release.- Returns:
- String
-
getPomFileName
Get the file name of the POM to pass to any executed Maven process.- Returns:
- String
-
getPreparationGoals
Get the goals to execute in preparation for the release.- Returns:
- String
-
getProjectNamingPolicyId
Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.- Returns:
- String
-
getProjectVersionPolicyId
Get the role-hint for the VersionPolicy implementation used to calculate the project versions.- Returns:
- String
-
getReleaseStrategyId
Get the role-hint for the release Strategy implementation.- Returns:
- String
-
getScmBranchBase
Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.- Returns:
- String
-
getScmBranchCommitComment
Get the SCM commit comment when branching.- Returns:
- String
-
getScmCommentPrefix
Get the prefix of SCM modification messages.- Returns:
- String
-
getScmDevelopmentCommitComment
Get the SCM commit comment when setting pom.xml back to development.- Returns:
- String
-
getScmId
Get the id can be used to get the credentials by the server-id from the settings.xml.- Returns:
- String
-
getScmPassword
Get the password for the user interacting with the scm.- Returns:
- String
-
getScmPrivateKey
Get private key for an SSH based SCM repository.- Returns:
- String
-
getScmPrivateKeyPassPhrase
Get pass phrase for the private key.- Returns:
- String
-
getScmRelativePathProjectDirectory
Get relative path of the project returned by the checkout command.- Returns:
- String
-
getScmReleaseCommitComment
Get the SCM commit comment when setting pom.xml to release.- Returns:
- String
-
getScmReleaseLabel
Get tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0.- Returns:
- String
-
getScmReleasedPomRevision
Get nOTE : currently only implemented with svn scm. It contains the revision of the committed released pom to remotely tag the source code with this revision.- Returns:
- String
-
getScmRollbackCommitComment
Get the SCM commit comment when rolling back.- Returns:
- String
-
getScmSourceUrl
Get this is a MavenSCM of where you're going to get the sources to make the release with. Example: scm:svn:https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-release-plugin.- Returns:
- String
-
getScmTagBase
Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.- Returns:
- String
-
getScmTagNameFormat
Get specifies the format for generating a tag name. Property expansion is used with the optional prefix of project, where properties are delimited with @{ and }.- Returns:
- String
-
getScmUsername
Get the user name to interact with the scm.- Returns:
- String
-
getWaitBeforeTagging
public int getWaitBeforeTagging()Get wait the specified number of seconds before creating a tag.- Returns:
- int
-
getWorkItem
Get some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered. This field allows you to specify that Work Item or Task. It is optional, and only relevant if pushChanges is true.- Returns:
- String
-
getWorkingDirectory
Get the directory where the release is performed.- Returns:
- String
-
isAddSchema
public boolean isAddSchema()Get whether to add the model schema to the top of the rewritten POM if it wasn't there already. Iffalse
then the root element will remain untouched.- Returns:
- boolean
-
isAllowTimestampedSnapshots
public boolean isAllowTimestampedSnapshots()Get should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.- Returns:
- boolean
-
isAutoVersionSubmodules
public boolean isAutoVersionSubmodules()Get whether to use the parent pom version for submodule versions.- Returns:
- boolean
-
isBranchCreation
public boolean isBranchCreation()Get whether to create a branch instead of do a release.- Returns:
- boolean
-
isCommitByProject
public boolean isCommitByProject()Get the commits must be done by modules or not. Set it to true in case of flat directory structure.- Returns:
- boolean
-
isGenerateReleasePoms
public boolean isGenerateReleasePoms()Get whether to generate release POMs.- Returns:
- boolean
-
isInteractive
public boolean isInteractive()Get whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.- Returns:
- boolean
-
isLocalCheckout
public boolean isLocalCheckout()Get if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network. This is very helpful for releasing large projects!- Returns:
- boolean
-
isPushChanges
public boolean isPushChanges()Get should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.- Returns:
- boolean
-
isRemoteTagging
public boolean isRemoteTagging()Get nOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406).- Returns:
- boolean
-
isScmUseEditMode
public boolean isScmUseEditMode()Get whether to use edit mode when making SCM modifications. This setting is disregarded if the SCM does not support edit mode, or if edit mode is compulsory for the given SCM.- Returns:
- boolean
-
isSnapshotReleasePluginAllowed
public boolean isSnapshotReleasePluginAllowed()Get whether a SNAPSHOT of the release plugin is allowed.- Returns:
- boolean
-
isSuppressCommitBeforeTagOrBranch
public boolean isSuppressCommitBeforeTagOrBranch()Get whether to suppress a commit of changes to the working copy before a tag or branch is created.- Returns:
- boolean
-
isUpdateBranchVersions
public boolean isUpdateBranchVersions()Get whether to update branch POM versions.- Returns:
- boolean
-
isUpdateDependencies
public boolean isUpdateDependencies()Get if updateDependencies is false, dependencies version won't be updated to the next development version.- Returns:
- boolean
-
isUpdateVersionsToSnapshot
public boolean isUpdateVersionsToSnapshot()Get whether to update branch versions to SNAPSHOT.- Returns:
- boolean
-
isUpdateWorkingCopyVersions
public boolean isUpdateWorkingCopyVersions()Get whether to update working copy POM versions.- Returns:
- boolean
-
isUseReleaseProfile
public boolean isUseReleaseProfile()Get whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, this will set the property "performRelease" to true.- Returns:
- boolean
-
removeActivateProfile
Method removeActivateProfile.- Parameters:
string
- a string object.
-
removeCheckModificationExclude
Method removeCheckModificationExclude.- Parameters:
string
- a string object.
-
setActivateProfiles
Set list of profiles to activate.- Parameters:
activateProfiles
- a activateProfiles object.
-
setAddSchema
public void setAddSchema(boolean addSchema) Set whether to add the model schema to the top of the rewritten POM if it wasn't there already. Iffalse
then the root element will remain untouched.- Parameters:
addSchema
- a addSchema object.
-
setAdditionalArguments
Set additional arguments to pass to any executed Maven process.- Parameters:
additionalArguments
- a additionalArguments object.
-
setAllowTimestampedSnapshots
public void setAllowTimestampedSnapshots(boolean allowTimestampedSnapshots) Set should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.- Parameters:
allowTimestampedSnapshots
- a allowTimestampedSnapshots object.
-
setAutoVersionSubmodules
public void setAutoVersionSubmodules(boolean autoVersionSubmodules) Set whether to use the parent pom version for submodule versions.- Parameters:
autoVersionSubmodules
- a autoVersionSubmodules object.
-
setBranchCreation
public void setBranchCreation(boolean branchCreation) Set whether to create a branch instead of do a release.- Parameters:
branchCreation
- a branchCreation object.
-
setCheckModificationExcludes
Set in some exceptions you want to allow changes to the working copy. Changes to files listed here will not make the ScmCheckModificationsPhase fail.- Parameters:
checkModificationExcludes
- a checkModificationExcludes object.
-
setCheckoutDirectory
Set the directory where the tag will be checked out.- Parameters:
checkoutDirectory
- a checkoutDirectory object.
-
setCommitByProject
public void setCommitByProject(boolean commitByProject) Set the commits must be done by modules or not. Set it to true in case of flat directory structure.- Parameters:
commitByProject
- a commitByProject object.
-
setCompletedPhase
Set the last completed phase.- Parameters:
completedPhase
- a completedPhase object.
-
setCompletionGoals
Set the goals to execute in on completion of preparation for the release.- Parameters:
completionGoals
- a completionGoals object.
-
setDefaultDevelopmentVersion
Set default version to use for new working copy.- Parameters:
defaultDevelopmentVersion
- a defaultDevelopmentVersion object.
-
setDefaultReleaseVersion
Set default version to use for the tagged release or the new branch.- Parameters:
defaultReleaseVersion
- a defaultReleaseVersion object.
-
setDescription
Set the description of this release configuration.- Parameters:
description
- a description object.
-
setGenerateReleasePoms
public void setGenerateReleasePoms(boolean generateReleasePoms) Set whether to generate release POMs.- Parameters:
generateReleasePoms
- a generateReleasePoms object.
-
setInteractive
public void setInteractive(boolean interactive) Set whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.- Parameters:
interactive
- a interactive object.
-
setLocalCheckout
public void setLocalCheckout(boolean localCheckout) Set if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network. This is very helpful for releasing large projects!- Parameters:
localCheckout
- a localCheckout object.
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding
- a modelEncoding object.
-
setName
Set the name of this release configuration.- Parameters:
name
- a name object.
-
setPerformGoals
Set the goals to execute in perform phase for the release.- Parameters:
performGoals
- a performGoals object.
-
setPomFileName
Set the file name of the POM to pass to any executed Maven process.- Parameters:
pomFileName
- a pomFileName object.
-
setPreparationGoals
Set the goals to execute in preparation for the release.- Parameters:
preparationGoals
- a preparationGoals object.
-
setProjectNamingPolicyId
Set the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.- Parameters:
projectNamingPolicyId
- a projectNamingPolicyId object.
-
setProjectVersionPolicyId
Set the role-hint for the VersionPolicy implementation used to calculate the project versions.- Parameters:
projectVersionPolicyId
- a projectVersionPolicyId object
-
setPushChanges
public void setPushChanges(boolean pushChanges) Set should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.- Parameters:
pushChanges
- a pushChanges object.
-
setReleaseStrategyId
Set the role-hint for the release Strategy implementation.- Parameters:
releaseStrategyId
- a releaseStrategyId object.
-
setRemoteTagging
public void setRemoteTagging(boolean remoteTagging) Set nOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406).- Parameters:
remoteTagging
- a remoteTagging object.
-
setScmBranchBase
Set where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.- Parameters:
scmBranchBase
- a scmBranchBase object.
-
setScmBranchCommitComment
Set the SCM commit comment when branching.- Parameters:
scmBranchCommitComment
- a scmBranchCommitComment object
-
setScmCommentPrefix
Set the prefix of SCM modification messages.- Parameters:
ScmCommentPrefix
- a ScmCommentPrefix object.
-
setScmDevelopmentCommitComment
Set the SCM commit comment when setting pom.xml back to development.- Parameters:
scmDevelopmentCommitComment
- a scmDevelopmentCommitComment object.
-
setScmId
Set the id can be used to get the credentials by the server-id from the settings.xml.- Parameters:
scmId
- a scmId object.
-
setScmPassword
Set the password for the user interacting with the scm.- Parameters:
scmPassword
- a scmPassword object.
-
setScmPrivateKey
Set private key for an SSH based SCM repository.- Parameters:
scmPrivateKey
- a scmPrivateKey object.
-
setScmPrivateKeyPassPhrase
Set pass phrase for the private key.- Parameters:
scmPrivateKeyPassPhrase
- a scmPrivateKeyPassPhrase object.
-
setScmRelativePathProjectDirectory
Set relative path of the project returned by the checkout command.- Parameters:
scmRelativePathProjectDirectory
- a scmRelativePathProjectDirectory object.
-
setScmReleaseCommitComment
Set the SCM commit comment when setting pom.xml to release.- Parameters:
scmReleaseCommitComment
- a scmReleaseCommitComment object.
-
setScmReleaseLabel
Set tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0.- Parameters:
scmReleaseLabel
- a scmReleaseLabel object.
-
setScmReleasedPomRevision
Set nOTE : currently only implemented with svn scm. It contains the revision of the committed released pom to remotely tag the source code with this revision.- Parameters:
scmReleasedPomRevision
- a scmReleasedPomRevision object
-
setScmRollbackCommitComment
Set the SCM commit comment when rolling back.- Parameters:
scmRollbackCommitComment
- a scmRollbackCommitComment object.
-
setScmSourceUrl
Set this is a MavenSCM of where you're going to get the sources to make the release with. Example: scm:svn:https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-release-plugin.- Parameters:
scmSourceUrl
- a scmSourceUrl object.
-
setScmTagBase
Set where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.- Parameters:
scmTagBase
- a scmTagBase object.
-
setScmTagNameFormat
Set specifies the format for generating a tag name. Property expansion is used with the optional prefix of project, where properties are delimited with @{ and }.- Parameters:
scmTagNameFormat
- a scmTagNameFormat object.
-
setScmUseEditMode
public void setScmUseEditMode(boolean scmUseEditMode) Set whether to use edit mode when making SCM modifications. This setting is disregarded if the SCM does not support edit mode, or if edit mode is compulsory for the given SCM.- Parameters:
scmUseEditMode
- a scmUseEditMode object.
-
setScmUsername
Set the user name to interact with the scm.- Parameters:
scmUsername
- a scmUsername object.
-
setSnapshotReleasePluginAllowed
public void setSnapshotReleasePluginAllowed(boolean snapshotReleasePluginAllowed) Set whether a SNAPSHOT of the release plugin is allowed.- Parameters:
snapshotReleasePluginAllowed
- a snapshotReleasePluginAllowed object.
-
setSuppressCommitBeforeTagOrBranch
public void setSuppressCommitBeforeTagOrBranch(boolean suppressCommitBeforeTagOrBranch) Set whether to suppress a commit of changes to the working copy before a tag or branch is created.- Parameters:
suppressCommitBeforeTagOrBranch
- a suppressCommitBeforeTagOrBranch object.
-
setUpdateBranchVersions
public void setUpdateBranchVersions(boolean updateBranchVersions) Set whether to update branch POM versions.- Parameters:
updateBranchVersions
- a updateBranchVersions object.
-
setUpdateDependencies
public void setUpdateDependencies(boolean updateDependencies) Set if updateDependencies is false, dependencies version won't be updated to the next development version.- Parameters:
updateDependencies
- a updateDependencies object.
-
setUpdateVersionsToSnapshot
public void setUpdateVersionsToSnapshot(boolean updateVersionsToSnapshot) Set whether to update branch versions to SNAPSHOT.- Parameters:
updateVersionsToSnapshot
- a updateVersionsToSnapshot object.
-
setUpdateWorkingCopyVersions
public void setUpdateWorkingCopyVersions(boolean updateWorkingCopyVersions) Set whether to update working copy POM versions.- Parameters:
updateWorkingCopyVersions
- a updateWorkingCopyVersions object.
-
setUseReleaseProfile
public void setUseReleaseProfile(boolean useReleaseProfile) Set whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, this will set the property "performRelease" to true.- Parameters:
useReleaseProfile
- a useReleaseProfile object.
-
setWaitBeforeTagging
public void setWaitBeforeTagging(int waitBeforeTagging) Set wait the specified number of seconds before creating a tag.- Parameters:
waitBeforeTagging
- a waitBeforeTagging object.
-
setWorkItem
Set some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered. This field allows you to specify that Work Item or Task. It is optional, and only relevant if pushChanges is true.- Parameters:
workItem
- a workItem object.
-
setWorkingDirectory
Set the directory where the release is performed.- Parameters:
workingDirectory
- a workingDirectory object.
-
getProjectVersions
Map<String,ReleaseStageVersions> getProjectVersions() -
getOriginalScmInfo
-
getResolvedSnapshotDependencies
Map<String,ReleaseStageVersions> getResolvedSnapshotDependencies()Method getResolvedSnapshotDependencies.- Returns:
- Map
-
getProjectReleaseVersion
-
addReleaseVersion
Method addReleaseVersion.- Parameters:
key
-value
-
-
getProjectDevelopmentVersion
-
addDevelopmentVersion
Method addDevelopmentVersion.- Parameters:
key
-value
-
-
getOriginalScmInfo
Method getOriginalScmInfo.- Returns:
- Map
-
addOriginalScmInfo
Method addOriginalScmInfo.- Parameters:
key
-value
-
-
getProjectOriginalVersion
-
addOriginalVersion
-
getDependencyDevelopmentVersion
Retrieve the release version for the resolved snapshot dependency. -
getDependencyReleaseVersion
Retrieve the release version for the resolved snapshot dependency. -
getDependencyOriginalVersion
Retrieve the original version for the resolved snapshot dependency. -
addDependencyOriginalVersion
-
addDependencyReleaseVersion
-
addDependencyDevelopmentVersion
-
computeIfAbsent
private static ReleaseStageVersions computeIfAbsent(Map<String, ReleaseStageVersions> map, String key) -
equals
-
compareScmCollections
-
hashCode
public int hashCode()
-