public class ReleaseDescriptor extends Object implements Serializable
Modifier and Type | Field and Description |
---|---|
static String |
DEVELOPMENT_KEY |
static String |
ORIGINAL_VERSION |
static String |
RELEASE_KEY |
Constructor and Description |
---|
ReleaseDescriptor() |
Modifier and Type | Method and Description |
---|---|
void |
addCheckModificationExclude(String string)
Method addCheckModificationExclude.
|
void |
addDevelopmentVersion(Object key,
String value)
Method addDevelopmentVersion.
|
void |
addOriginalScmInfo(Object key,
String value)
Method addOriginalScmInfo.
|
void |
addReleaseVersion(Object key,
String value)
Method addReleaseVersion.
|
void |
addResolvedSnapshotDependency(Object key,
String value)
Method addResolvedSnapshotDependency.
|
boolean |
equals(Object obj) |
String |
getAdditionalArguments()
Get additional arguments to pass to any executed Maven
process.
|
List<String> |
getCheckModificationExcludes()
Method getCheckModificationExcludes.
|
String |
getCheckoutDirectory()
Get the directory where the tag will be checked out.
|
String |
getCompletedPhase()
Get the last completed phase.
|
String |
getCompletionGoals()
Get the goals to execute in on completion of preparation for
the release.
|
String |
getDefaultDevelopmentVersion()
Get default version to use for new working copy.
|
String |
getDefaultReleaseVersion()
Get default version to use for the tagged release or the new
branch.
|
String |
getDependencyDevelopmentVersion(String artifactConflictId)
Retrieve the release version for the resolved snapshot dependency.
|
String |
getDependencyReleaseVersion(String artifactConflictId)
Retrieve the release version for the resolved snapshot dependency.
|
String |
getDescription()
Get the description of this release configuration.
|
Map<Object,String> |
getDevelopmentVersions()
Method getDevelopmentVersions.
|
String |
getModelEncoding()
Get the modelEncoding field.
|
String |
getName()
Get the name of this release configuration.
|
Map<Object,String> |
getOriginalScmInfo()
Method getOriginalScmInfo.
|
Map |
getOriginalVersions(List reactorProjects)
Retrieve the original version map, before transformation, keyed by project's versionless identifier.
|
String |
getPerformGoals()
Get the goals to execute in perform phase for the release.
|
String |
getPomFileName()
Get the file name of the POM to pass to any executed Maven
process.
|
String |
getPreparationGoals()
Get the goals to execute in preparation for the release.
|
Map<Object,String> |
getReleaseVersions()
Method getReleaseVersions.
|
Map<Object,String> |
getResolvedSnapshotDependencies()
Method getResolvedSnapshotDependencies.
|
String |
getScmBranchBase()
Get where you are going to put your branched sources
Example
https://svn.apache.org/repos/asf/maven/plugins/branches.
|
String |
getScmCommentPrefix()
Get the prefix of SCM modification messages.
|
String |
getScmPassword()
Get the password for the user interacting with the scm.
|
String |
getScmPrivateKey()
Get private key for an SSH based SCM repository.
|
String |
getScmPrivateKeyPassPhrase()
Get pass phrase for the private key.
|
String |
getScmRelativePathProjectDirectory()
Get relative path of the project returned by the checkout
command.
|
String |
getScmReleasedPomRevision()
Get nOTE : currently only implemented with svn scm.
|
String |
getScmReleaseLabel()
Get tag name: the identifier for the tag.
|
String |
getScmSourceUrl()
Get this is a MavenSCM of where you're going to get the
sources to make the release with.
|
String |
getScmTagBase()
Get where you are going to put your tagged sources
Example
https://svn.apache.org/repos/asf/maven/plugins/tags.
|
String |
getScmTagNameFormat()
Get specifies the format for generating a tag name.
|
String |
getScmUsername()
Get the user name to interact with the scm.
|
int |
getWaitBeforeTagging()
Get wait the specified number of seconds before creating a
tag.
|
String |
getWorkingDirectory()
Get the directory where the release is performed.
|
int |
hashCode() |
boolean |
isAddSchema()
Get whether to add the model schema to the top of the
rewritten POM if it wasn't there already.
|
boolean |
isAllowTimestampedSnapshots()
Get should timestamped SNAPSHOT dependencies be allowed?
Default is to fail when any SNAPSHOT
dependency is found.
|
boolean |
isAutoVersionSubmodules()
Get whether to use the parent pom version for submodule
verstions.
|
boolean |
isBranchCreation()
Get whether to create a branch instead of do a release.
|
boolean |
isCommitByProject()
Get the commits must be done by modules or not.
|
boolean |
isGenerateReleasePoms()
Get whether to generate release POMs.
|
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.
|
boolean |
isLocalCheckout()
Get if the scm provider should use local checkouts via
file://${basedir}
instead of doing a clean checkout over the
network.
|
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.
|
boolean |
isRemoteTagging()
Get nOTE : currently only implemented with svn scm.
|
boolean |
isScmUseEditMode()
Get whether to use edit mode when making SCM modifications.
|
boolean |
isSnapshotReleasePluginAllowed()
Get whether a SNAPSHOT of the release plugin is allowed.
|
boolean |
isSuppressCommitBeforeTagOrBranch()
Get whether to suppress a commit of changes to the working
copy before a tag or branch is created.
|
boolean |
isUpdateBranchVersions()
Get whether to update branch POM versions.
|
boolean |
isUpdateDependencies()
Get if updateDependencies is false, dependencies version
won't be updated to the next development version.
|
boolean |
isUpdateVersionsToSnapshot()
Get whether to update branch versions to SNAPSHOT.
|
boolean |
isUpdateWorkingCopyVersions()
Get whether to update working copy POM versions.
|
boolean |
isUseReleaseProfile()
Get whether to use the release profile that adds sources and
javadocs to the released artifact, if appropriate.
|
void |
mapDevelopmentVersion(String projectId,
String nextVersion)
Map a given project to a specified version from when it is incremented and placed back into development.
|
void |
mapOriginalScmInfo(String projectId,
org.apache.maven.model.Scm scm)
Map a given project to a specified set of SCM information.
|
void |
mapReleaseVersion(String projectId,
String nextVersion)
Map a given project to a specified version from when it is released.
|
void |
mapResolvedSnapshotDependencies(String artifactName,
String releaseVersion,
String developmentVersion)
Map a given snapshot dependency to a specified version from when it is released.
|
void |
removeCheckModificationExclude(String string)
Method removeCheckModificationExclude.
|
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
verstions.
|
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 |
setDevelopmentVersions(Map developmentVersions)
Set a map of projects to versions to use when moving the
given projects back into devlopment after release.
|
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 |
setName(String name)
Set the name of this release configuration.
|
void |
setOriginalScmInfo(Map originalScmInfo)
Set a map of projects to original SCM information.
|
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 |
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 |
setReleaseVersions(Map releaseVersions)
Set a map of projects to versions to use when releasing the
given projects.
|
void |
setRemoteTagging(boolean remoteTagging)
Set nOTE : currently only implemented with svn scm.
|
void |
setResolvedSnapshotDependencies(Map resolvedSnapshotDependencies)
Set a map of resolved snapshot dependencies versions.
|
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 |
setScmCommentPrefix(String ScmCommentPrefix)
Set the prefix of SCM modification messages.
|
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 |
setScmReleasedPomRevision(String scmReleasedPomRevision)
Set nOTE : currently only implemented with svn scm.
|
void |
setScmReleaseLabel(String scmReleaseLabel)
Set tag name: the identifier for the tag.
|
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.
|
public static final String DEVELOPMENT_KEY
public static final String RELEASE_KEY
public static final String ORIGINAL_VERSION
public void addCheckModificationExclude(String string)
string
- a string object.public void addDevelopmentVersion(Object key, String value)
key
- a key object.value
- a value object.public void addOriginalScmInfo(Object key, String value)
key
- a key object.value
- a value object.public void addReleaseVersion(Object key, String value)
key
- a key object.value
- a value object.public void addResolvedSnapshotDependency(Object key, String value)
key
- a key object.value
- a value object.public String getAdditionalArguments()
public List<String> getCheckModificationExcludes()
public String getCheckoutDirectory()
public String getCompletedPhase()
public String getCompletionGoals()
public String getDefaultDevelopmentVersion()
public String getDefaultReleaseVersion()
public String getDescription()
public Map<Object,String> getDevelopmentVersions()
public String getModelEncoding()
public String getName()
public Map<Object,String> getOriginalScmInfo()
public String getPerformGoals()
public String getPomFileName()
public String getPreparationGoals()
public Map<Object,String> getReleaseVersions()
public Map<Object,String> getResolvedSnapshotDependencies()
public String getScmBranchBase()
public String getScmCommentPrefix()
public String getScmPassword()
public String getScmPrivateKey()
public String getScmPrivateKeyPassPhrase()
public String getScmRelativePathProjectDirectory()
public String getScmReleaseLabel()
public String getScmReleasedPomRevision()
public String getScmSourceUrl()
public String getScmTagBase()
public String getScmTagNameFormat()
public String getScmUsername()
public int getWaitBeforeTagging()
public String getWorkingDirectory()
public boolean isAddSchema()
false
then the root element will
remain untouched.public boolean isAllowTimestampedSnapshots()
public boolean isAutoVersionSubmodules()
public boolean isBranchCreation()
public boolean isCommitByProject()
public boolean isGenerateReleasePoms()
public boolean isInteractive()
public boolean isLocalCheckout()
public boolean isPushChanges()
public boolean isRemoteTagging()
public boolean isScmUseEditMode()
public boolean isSnapshotReleasePluginAllowed()
public boolean isSuppressCommitBeforeTagOrBranch()
public boolean isUpdateBranchVersions()
public boolean isUpdateDependencies()
public boolean isUpdateVersionsToSnapshot()
public boolean isUpdateWorkingCopyVersions()
public boolean isUseReleaseProfile()
public void removeCheckModificationExclude(String string)
string
- a string object.public void setAddSchema(boolean addSchema)
false
then the root element will
remain untouched.addSchema
- a addSchema object.public void setAdditionalArguments(String additionalArguments)
additionalArguments
- a additionalArguments object.public void setAllowTimestampedSnapshots(boolean allowTimestampedSnapshots)
allowTimestampedSnapshots
- a allowTimestampedSnapshots
object.public void setAutoVersionSubmodules(boolean autoVersionSubmodules)
autoVersionSubmodules
- a autoVersionSubmodules object.public void setBranchCreation(boolean branchCreation)
branchCreation
- a branchCreation object.public void setCheckModificationExcludes(List<String> checkModificationExcludes)
checkModificationExcludes
- a checkModificationExcludes
object.public void setCheckoutDirectory(String checkoutDirectory)
checkoutDirectory
- a checkoutDirectory object.public void setCommitByProject(boolean commitByProject)
commitByProject
- a commitByProject object.public void setCompletedPhase(String completedPhase)
completedPhase
- a completedPhase object.public void setCompletionGoals(String completionGoals)
completionGoals
- a completionGoals object.public void setDefaultDevelopmentVersion(String defaultDevelopmentVersion)
defaultDevelopmentVersion
- a defaultDevelopmentVersion
object.public void setDefaultReleaseVersion(String defaultReleaseVersion)
defaultReleaseVersion
- a defaultReleaseVersion object.public void setDescription(String description)
description
- a description object.public void setDevelopmentVersions(Map developmentVersions)
developmentVersions
- a developmentVersions object.public void setGenerateReleasePoms(boolean generateReleasePoms)
generateReleasePoms
- a generateReleasePoms object.public void setInteractive(boolean interactive)
interactive
- a interactive object.public void setLocalCheckout(boolean localCheckout)
localCheckout
- a localCheckout object.public void setModelEncoding(String modelEncoding)
modelEncoding
- a modelEncoding object.public void setName(String name)
name
- a name object.public void setOriginalScmInfo(Map originalScmInfo)
originalScmInfo
- a originalScmInfo object.public void setPerformGoals(String performGoals)
performGoals
- a performGoals object.public void setPomFileName(String pomFileName)
pomFileName
- a pomFileName object.public void setPreparationGoals(String preparationGoals)
preparationGoals
- a preparationGoals object.public void setPushChanges(boolean pushChanges)
pushChanges
- a pushChanges object.public void setReleaseVersions(Map releaseVersions)
releaseVersions
- a releaseVersions object.public void setRemoteTagging(boolean remoteTagging)
remoteTagging
- a remoteTagging object.public void setResolvedSnapshotDependencies(Map resolvedSnapshotDependencies)
resolvedSnapshotDependencies
- a
resolvedSnapshotDependencies object.public void setScmBranchBase(String scmBranchBase)
scmBranchBase
- a scmBranchBase object.public void setScmCommentPrefix(String ScmCommentPrefix)
ScmCommentPrefix
- a ScmCommentPrefix object.public void setScmPassword(String scmPassword)
scmPassword
- a scmPassword object.public void setScmPrivateKey(String scmPrivateKey)
scmPrivateKey
- a scmPrivateKey object.public void setScmPrivateKeyPassPhrase(String scmPrivateKeyPassPhrase)
scmPrivateKeyPassPhrase
- a scmPrivateKeyPassPhrase
object.public void setScmRelativePathProjectDirectory(String scmRelativePathProjectDirectory)
scmRelativePathProjectDirectory
- a
scmRelativePathProjectDirectory object.public void setScmReleaseLabel(String scmReleaseLabel)
scmReleaseLabel
- a scmReleaseLabel object.public void setScmReleasedPomRevision(String scmReleasedPomRevision)
scmReleasedPomRevision
- a scmReleasedPomRevision objectpublic void setScmSourceUrl(String scmSourceUrl)
scmSourceUrl
- a scmSourceUrl object.public void setScmTagBase(String scmTagBase)
scmTagBase
- a scmTagBase object.public void setScmTagNameFormat(String scmTagNameFormat)
scmTagNameFormat
- a scmTagNameFormat object.public void setScmUseEditMode(boolean scmUseEditMode)
scmUseEditMode
- a scmUseEditMode object.public void setScmUsername(String scmUsername)
scmUsername
- a scmUsername object.public void setSnapshotReleasePluginAllowed(boolean snapshotReleasePluginAllowed)
snapshotReleasePluginAllowed
- a
snapshotReleasePluginAllowed object.public void setSuppressCommitBeforeTagOrBranch(boolean suppressCommitBeforeTagOrBranch)
suppressCommitBeforeTagOrBranch
- a
suppressCommitBeforeTagOrBranch object.public void setUpdateBranchVersions(boolean updateBranchVersions)
updateBranchVersions
- a updateBranchVersions object.public void setUpdateDependencies(boolean updateDependencies)
updateDependencies
- a updateDependencies object.public void setUpdateVersionsToSnapshot(boolean updateVersionsToSnapshot)
updateVersionsToSnapshot
- a updateVersionsToSnapshot
object.public void setUpdateWorkingCopyVersions(boolean updateWorkingCopyVersions)
updateWorkingCopyVersions
- a updateWorkingCopyVersions
object.public void setUseReleaseProfile(boolean useReleaseProfile)
useReleaseProfile
- a useReleaseProfile object.public void setWaitBeforeTagging(int waitBeforeTagging)
waitBeforeTagging
- a waitBeforeTagging object.public void setWorkingDirectory(String workingDirectory)
workingDirectory
- a workingDirectory object.public void mapResolvedSnapshotDependencies(String artifactName, String releaseVersion, String developmentVersion)
public void mapReleaseVersion(String projectId, String nextVersion)
projectId
- the project's group and artifact IDnextVersion
- the version to map topublic void mapDevelopmentVersion(String projectId, String nextVersion)
projectId
- the project's group and artifact IDnextVersion
- the version to map topublic void mapOriginalScmInfo(String projectId, org.apache.maven.model.Scm scm)
projectId
- the project's group and artifact IDscm
- the original SCM information to storepublic Map getOriginalVersions(List reactorProjects)
reactorProjects
- The reactor projects.public String getDependencyDevelopmentVersion(String artifactConflictId)
public String getDependencyReleaseVersion(String artifactConflictId)
Copyright © 2002–2024 The Apache Software Foundation. All rights reserved.