Interface ReleaseDescriptor
-
- All Known Implementing Classes:
ReleaseDescriptorBuilder.BuilderReleaseDescriptor
public interface ReleaseDescriptor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDependencyDevelopmentVersion(java.lang.String versionlessKey, java.lang.String version)
void
addDependencyOriginalVersion(java.lang.String versionlessKey, java.lang.String string)
void
addDependencyReleaseVersion(java.lang.String versionlessKey, java.lang.String version)
void
addDevelopmentVersion(java.lang.String projectId, java.lang.String nextVersion)
void
addReleaseVersion(java.lang.String projectId, java.lang.String nextVersion)
java.util.List<java.lang.String>
getActivateProfiles()
java.lang.String
getAdditionalArguments()
Get additional arguments to pass to any executed Maven process.java.util.List<java.lang.String>
getCheckModificationExcludes()
Method getCheckModificationExcludes.java.lang.String
getCheckoutDirectory()
Get the directory where the tag will be checked out.java.lang.String
getCompletedPhase()
Get the last completed phase.java.lang.String
getCompletionGoals()
Get the goals to execute in on completion of preparation for the release.java.lang.String
getDefaultDevelopmentVersion()
Get default version to use for new working copy.java.lang.String
getDefaultReleaseVersion()
Get default version to use for the tagged release or the new branch.java.lang.String
getDependencyDevelopmentVersion(java.lang.String artifactKey)
Retrieve the release version for the resolved snapshot dependency.java.lang.String
getDependencyOriginalVersion(java.lang.String artifactKey)
Retrieve the original version for the resolved snapshot dependency.java.lang.String
getDependencyReleaseVersion(java.lang.String artifactKey)
Retrieve the release version for the resolved snapshot dependency.org.apache.maven.model.Scm
getOriginalScmInfo(java.lang.String projectKey)
Method getOriginalScmInfo.java.lang.String
getPerformGoals()
Get the goals to execute in perform phase for the release.java.lang.String
getPomFileName()
Get the file name of the POM to pass to any executed Maven process.java.lang.String
getPreparationGoals()
Get the goals to execute in preparation for the release.java.lang.String
getProjectDevelopmentVersion(java.lang.String projectKey)
java.lang.String
getProjectNamingPolicyId()
Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.java.lang.String
getProjectOriginalVersion(java.lang.String projectKey)
java.lang.String
getProjectReleaseVersion(java.lang.String key)
java.lang.String
getProjectVersionPolicyId()
Get the role-hint for the VersionPolicy implementation used to calculate the project versions.java.lang.String
getReleaseStrategyId()
Get the role-hint for the release Strategy implementation.java.lang.String
getScmBranchBase()
Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.java.lang.String
getScmBranchCommitComment()
Get the SCM commit comment when branching.java.lang.String
getScmCommentPrefix()
Get the prefix of SCM modification messages.java.lang.String
getScmDevelopmentCommitComment()
Get the SCM commit comment when setting pom.xml back to development.java.lang.String
getScmId()
Get the id can be used to get the credentials by the server-id from the settings.xml.java.lang.String
getScmPassword()
Get the password for the user interacting with the scm.java.lang.String
getScmPrivateKey()
Get private key for an SSH based SCM repository.java.lang.String
getScmPrivateKeyPassPhrase()
Get pass phrase for the private key.java.lang.String
getScmRelativePathProjectDirectory()
Get relative path of the project returned by the checkout command.java.lang.String
getScmReleaseCommitComment()
Get the SCM commit comment when setting pom.xml to release.java.lang.String
getScmReleasedPomRevision()
Get nOTE : currently only implemented with svn scm.java.lang.String
getScmReleaseLabel()
Get tag or branch name: the identifier for the tag/branch.java.lang.String
getScmRollbackCommitComment()
Get the SCM commit comment when rolling back.java.lang.String
getScmSourceUrl()
Get this is a MavenSCM of where you're going to get the sources to make the release with.java.lang.String
getScmTagBase()
Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.java.lang.String
getScmTagNameFormat()
Get specifies the format for generating a tag name.java.lang.String
getScmUsername()
Get the user name to interact with the scm.int
getWaitBeforeTagging()
Get wait the specified number of seconds before creating a tag.java.lang.String
getWorkingDirectory()
Get the directory where the release is performed.java.lang.String
getWorkItem()
Get default version to use for new working copy.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 versions.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
setScmRelativePathProjectDirectory(java.lang.String scmRelativePathProjectDirectory)
void
setScmReleasedPomRevision(java.lang.String scmRevision)
void
setScmReleaseLabel(java.lang.String tag)
void
setScmSourceUrl(java.lang.String scmUrl)
-
-
-
Method Detail
-
isUpdateDependencies
boolean isUpdateDependencies()
Get if updateDependencies is false, dependencies version won't be updated to the next development version.- Returns:
- boolean
-
isUseReleaseProfile
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
-
isAutoVersionSubmodules
boolean isAutoVersionSubmodules()
Get whether to use the parent pom version for submodule versions.- Returns:
- boolean
-
isSnapshotReleasePluginAllowed
boolean isSnapshotReleasePluginAllowed()
Get whether a SNAPSHOT of the release plugin is allowed.- Returns:
- boolean
-
isCommitByProject
boolean isCommitByProject()
Get the commits must be done by modules or not. Set it to true in case of flat directory structure.- Returns:
- boolean
-
isBranchCreation
boolean isBranchCreation()
Get whether to create a branch instead of do a release.- Returns:
- boolean
-
isUpdateBranchVersions
boolean isUpdateBranchVersions()
Get whether to update branch POM versions.- Returns:
- boolean
-
isUpdateWorkingCopyVersions
boolean isUpdateWorkingCopyVersions()
Get whether to update working copy POM versions.- Returns:
- boolean
-
isSuppressCommitBeforeTagOrBranch
boolean isSuppressCommitBeforeTagOrBranch()
Get whether to suppress a commit of changes to the working copy before a tag or branch is created.- Returns:
- boolean
-
isAllowTimestampedSnapshots
boolean isAllowTimestampedSnapshots()
Get should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.- Returns:
- boolean
-
isUpdateVersionsToSnapshot
boolean isUpdateVersionsToSnapshot()
Get whether to update branch versions to SNAPSHOT.- Returns:
- boolean
-
isRemoteTagging
boolean isRemoteTagging()
Get nOTE : 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).- Returns:
- boolean
-
isLocalCheckout
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
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
-
getWorkItem
java.lang.String getWorkItem()
Get default version to use for new working copy. 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
-
getDefaultDevelopmentVersion
java.lang.String getDefaultDevelopmentVersion()
Get default version to use for new working copy.- Returns:
- String
-
getScmRelativePathProjectDirectory
java.lang.String getScmRelativePathProjectDirectory()
Get relative path of the project returned by the checkout command.- Returns:
- String
-
getCheckoutDirectory
java.lang.String getCheckoutDirectory()
Get the directory where the tag will be checked out.- Returns:
- String
-
getPerformGoals
java.lang.String getPerformGoals()
Get the goals to execute in perform phase for the release.- Returns:
- String
-
getDefaultReleaseVersion
java.lang.String getDefaultReleaseVersion()
Get default version to use for the tagged release or the new branch.- Returns:
- String
-
getScmReleasedPomRevision
java.lang.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
-
isAddSchema
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
-
isGenerateReleasePoms
boolean isGenerateReleasePoms()
Get whether to generate release POMs.- Returns:
- boolean
-
isInteractive
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
-
isScmUseEditMode
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
-
getActivateProfiles
java.util.List<java.lang.String> getActivateProfiles()
- Returns:
- list of profiles to activate
-
getCompletedPhase
java.lang.String getCompletedPhase()
Get the last completed phase.- Returns:
- String
-
getCheckModificationExcludes
java.util.List<java.lang.String> getCheckModificationExcludes()
Method getCheckModificationExcludes.- Returns:
- List
-
getAdditionalArguments
java.lang.String getAdditionalArguments()
Get additional arguments to pass to any executed Maven process.- Returns:
- String
-
getPreparationGoals
java.lang.String getPreparationGoals()
Get the goals to execute in preparation for the release.- Returns:
- String
-
getCompletionGoals
java.lang.String getCompletionGoals()
Get the goals to execute in on completion of preparation for the release.- Returns:
- String
-
getPomFileName
java.lang.String getPomFileName()
Get the file name of the POM to pass to any executed Maven process.- Returns:
- String
-
getScmCommentPrefix
java.lang.String getScmCommentPrefix()
Get the prefix of SCM modification messages.- Returns:
- String
-
getScmReleaseCommitComment
java.lang.String getScmReleaseCommitComment()
Get the SCM commit comment when setting pom.xml to release.- Returns:
- String
- Since:
- 3.0.0-M1
-
getScmDevelopmentCommitComment
java.lang.String getScmDevelopmentCommitComment()
Get the SCM commit comment when setting pom.xml back to development.- Returns:
- String
- Since:
- 3.0.0-M1
-
getScmBranchCommitComment
java.lang.String getScmBranchCommitComment()
Get the SCM commit comment when branching.- Returns:
- String
- Since:
- 3.0.0-M1
-
getScmRollbackCommitComment
java.lang.String getScmRollbackCommitComment()
Get the SCM commit comment when rolling back.- Returns:
- String
- Since:
- 3.0.0-M1
-
getScmPrivateKeyPassPhrase
java.lang.String getScmPrivateKeyPassPhrase()
Get pass phrase for the private key.- Returns:
- String
-
getScmPassword
java.lang.String getScmPassword()
Get the password for the user interacting with the scm.- Returns:
- String
-
getScmPrivateKey
java.lang.String getScmPrivateKey()
Get private key for an SSH based SCM repository.- Returns:
- String
-
getScmReleaseLabel
java.lang.String getScmReleaseLabel()
Get tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0.- Returns:
- String
-
getScmTagBase
java.lang.String getScmTagBase()
Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.- Returns:
- String
-
getScmBranchBase
java.lang.String getScmBranchBase()
Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.- Returns:
- String
-
getScmId
java.lang.String getScmId()
Get the id can be used to get the credentials by the server-id from the settings.xml.- Returns:
- String
-
getScmSourceUrl
java.lang.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
-
getScmUsername
java.lang.String getScmUsername()
Get the user name to interact with the scm.- Returns:
- String
-
getWaitBeforeTagging
int getWaitBeforeTagging()
Get wait the specified number of seconds before creating a tag.- Returns:
- int
-
getWorkingDirectory
java.lang.String getWorkingDirectory()
Get the directory where the release is performed.- Returns:
- String
-
getScmTagNameFormat
java.lang.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
-
getProjectNamingPolicyId
java.lang.String getProjectNamingPolicyId()
Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.- Returns:
- String
-
getProjectVersionPolicyId
java.lang.String getProjectVersionPolicyId()
Get the role-hint for the VersionPolicy implementation used to calculate the project versions.- Returns:
- String
-
getReleaseStrategyId
java.lang.String getReleaseStrategyId()
Get the role-hint for the release Strategy implementation.- Returns:
- String
-
getDependencyOriginalVersion
java.lang.String getDependencyOriginalVersion(java.lang.String artifactKey)
Retrieve the original version for the resolved snapshot dependency.
-
getDependencyReleaseVersion
java.lang.String getDependencyReleaseVersion(java.lang.String artifactKey)
Retrieve the release version for the resolved snapshot dependency.
-
getDependencyDevelopmentVersion
java.lang.String getDependencyDevelopmentVersion(java.lang.String artifactKey)
Retrieve the release version for the resolved snapshot dependency.
-
getProjectOriginalVersion
java.lang.String getProjectOriginalVersion(java.lang.String projectKey)
-
getProjectDevelopmentVersion
java.lang.String getProjectDevelopmentVersion(java.lang.String projectKey)
-
getProjectReleaseVersion
java.lang.String getProjectReleaseVersion(java.lang.String key)
-
getOriginalScmInfo
org.apache.maven.model.Scm getOriginalScmInfo(java.lang.String projectKey)
Method getOriginalScmInfo.- Returns:
- Map
-
addDependencyOriginalVersion
void addDependencyOriginalVersion(java.lang.String versionlessKey, java.lang.String string)
-
addDependencyReleaseVersion
void addDependencyReleaseVersion(java.lang.String versionlessKey, java.lang.String version)
-
addDependencyDevelopmentVersion
void addDependencyDevelopmentVersion(java.lang.String versionlessKey, java.lang.String version)
-
addReleaseVersion
void addReleaseVersion(java.lang.String projectId, java.lang.String nextVersion)
-
addDevelopmentVersion
void addDevelopmentVersion(java.lang.String projectId, java.lang.String nextVersion)
-
setScmReleaseLabel
void setScmReleaseLabel(java.lang.String tag)
-
setScmReleasedPomRevision
void setScmReleasedPomRevision(java.lang.String scmRevision)
-
setScmRelativePathProjectDirectory
void setScmRelativePathProjectDirectory(java.lang.String scmRelativePathProjectDirectory)
-
setScmSourceUrl
void setScmSourceUrl(java.lang.String scmUrl)
-
-