public interface ReleaseDescriptor
ReleaseDescriptor interface.
Modifier and Type | Method and Description |
---|---|
void |
addDependencyDevelopmentVersion(String versionlessKey,
String version)
addDependencyDevelopmentVersion.
|
void |
addDependencyOriginalVersion(String versionlessKey,
String string)
addDependencyOriginalVersion.
|
void |
addDependencyReleaseVersion(String versionlessKey,
String version)
addDependencyReleaseVersion.
|
void |
addDevelopmentVersion(String projectId,
String nextVersion)
addDevelopmentVersion.
|
void |
addReleaseVersion(String projectId,
String nextVersion)
addReleaseVersion.
|
List<String> |
getActivateProfiles()
getActivateProfiles.
|
String |
getAdditionalArguments()
Get additional arguments to pass to any executed Maven process.
|
String |
getAutoResolveSnapshots()
Returns whether unresolved SNAPSHOT dependencies should automatically be resolved.
|
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 artifactKey)
getDependencyDevelopmentVersion.
|
String |
getDependencyOriginalVersion(String artifactKey)
getDependencyOriginalVersion.
|
String |
getDependencyReleaseVersion(String artifactKey)
getDependencyReleaseVersion.
|
String |
getLineSeparator()
Get the line separator to use in the pom.xml.
|
org.apache.maven.model.Scm |
getOriginalScmInfo(String projectKey)
getOriginalScmInfo.
|
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.
|
String |
getProjectDevelopmentVersion(String projectKey)
getProjectDevelopmentVersion.
|
String |
getProjectNamingPolicyId()
Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
|
String |
getProjectOriginalVersion(String projectKey)
getProjectOriginalVersion.
|
String |
getProjectReleaseVersion(String key)
getProjectReleaseVersion.
|
Object |
getProjectVersionPolicyConfig()
Get the (optional) config for the VersionPolicy implementation used to calculate the project versions.
|
String |
getProjectVersionPolicyId()
Get the role-hint for the VersionPolicy implementation used to calculate the project versions.
|
String |
getReleaseStrategyId()
Get the role-hint for the release Strategy implementation.
|
String |
getScmBranchBase()
Get where you are going to put your branched sources Example
https://svn.apache.org/repos/asf/maven/plugins/branches.
|
String |
getScmBranchCommitComment()
Get the SCM commit comment when branching.
|
String |
getScmCommentPrefix()
Get the prefix of SCM modification messages.
|
String |
getScmDevelopmentCommitComment()
Get the SCM commit comment when setting pom.xml back to development.
|
String |
getScmId()
Get the id which can be used to get the (optionally encrypted) credentials with the given id from the
settings.xml . |
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 |
getScmReleaseCommitComment()
Get the SCM commit comment when setting pom.xml to release.
|
String |
getScmReleasedPomRevision()
Get nOTE : currently only implemented with svn scm.
|
String |
getScmReleaseLabel()
Get tag or branch name: the identifier for the tag/branch.
|
String |
getScmRollbackCommitComment()
Get the SCM commit comment when rolling back.
|
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.
|
String |
getWorkItem()
Get default version to use for new working copy.
|
boolean |
hasOriginalScmInfo(String projectKey)
hasOriginalScmInfo.
|
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 |
isPinExternals()
Determines whether the
--pin-externals option in svn copy command is enabled
which is new in Subversion 1.9. |
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 |
isScmShallowClone()
Get whether to use a shallow clone with no history or a full clone containing the full history during the
release.
|
boolean |
isScmSignTags()
Get if the scm provider should sign the tag.
|
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(String scmRelativePathProjectDirectory)
setScmRelativePathProjectDirectory.
|
void |
setScmReleasedPomRevision(String scmRevision)
setScmReleasedPomRevision.
|
void |
setScmReleaseLabel(String tag)
setScmReleaseLabel.
|
void |
setScmSourceUrl(String scmUrl)
setScmSourceUrl.
|
boolean isUpdateDependencies()
boolean isUseReleaseProfile()
boolean isAutoVersionSubmodules()
boolean isSnapshotReleasePluginAllowed()
boolean isCommitByProject()
boolean isBranchCreation()
boolean isUpdateBranchVersions()
boolean isUpdateWorkingCopyVersions()
boolean isSuppressCommitBeforeTagOrBranch()
boolean isAllowTimestampedSnapshots()
boolean isUpdateVersionsToSnapshot()
boolean isRemoteTagging()
boolean isScmSignTags()
boolean isLocalCheckout()
boolean isPushChanges()
String getWorkItem()
String getDefaultDevelopmentVersion()
String getScmRelativePathProjectDirectory()
String getCheckoutDirectory()
String getPerformGoals()
String getDefaultReleaseVersion()
String getScmReleasedPomRevision()
boolean isAddSchema()
false
then the root element will remain untouched.boolean isGenerateReleasePoms()
boolean isInteractive()
boolean isScmUseEditMode()
List<String> getActivateProfiles()
getActivateProfiles.
String getCompletedPhase()
List<String> getCheckModificationExcludes()
String getAdditionalArguments()
String getPreparationGoals()
String getCompletionGoals()
String getPomFileName()
String getScmCommentPrefix()
boolean isScmShallowClone()
String getScmReleaseCommitComment()
String getScmDevelopmentCommitComment()
String getScmBranchCommitComment()
String getScmRollbackCommitComment()
String getScmPrivateKeyPassPhrase()
String getScmPassword()
String getScmPrivateKey()
String getScmReleaseLabel()
String getScmTagBase()
String getScmBranchBase()
String getScmId()
settings.xml
.
Explicit credentials in getScmUsername()
, getScmPassword()
, getScmPrivateKey()
or
getScmPrivateKeyPassPhrase()
always take precedence, though.settings.xml
String getScmSourceUrl()
String getScmUsername()
int getWaitBeforeTagging()
String getWorkingDirectory()
String getScmTagNameFormat()
String getProjectNamingPolicyId()
String getProjectVersionPolicyId()
Object getProjectVersionPolicyConfig()
String getReleaseStrategyId()
String getDependencyOriginalVersion(String artifactKey)
getDependencyOriginalVersion.
artifactKey
- the artifact key String
String
The original version for the resolved snapshot dependency.String getDependencyReleaseVersion(String artifactKey)
getDependencyReleaseVersion.
artifactKey
- the artifact key String
String
the release version for the resolved snapshot dependency.String getDependencyDevelopmentVersion(String artifactKey)
getDependencyDevelopmentVersion.
artifactKey
- the artifact key String
String
the release version for the resolved snapshot dependency.String getProjectOriginalVersion(String projectKey)
getProjectOriginalVersion.
String getProjectDevelopmentVersion(String projectKey)
getProjectDevelopmentVersion.
org.apache.maven.model.Scm getOriginalScmInfo(String projectKey)
getOriginalScmInfo.
projectKey
- the project key String
Scm
information.boolean hasOriginalScmInfo(String projectKey)
hasOriginalScmInfo.
projectKey
- the project key String
void addDependencyOriginalVersion(String versionlessKey, String string)
addDependencyOriginalVersion.
void addDependencyReleaseVersion(String versionlessKey, String version)
addDependencyReleaseVersion.
void addDependencyDevelopmentVersion(String versionlessKey, String version)
addDependencyDevelopmentVersion.
void addDevelopmentVersion(String projectId, String nextVersion)
addDevelopmentVersion.
void setScmReleaseLabel(String tag)
setScmReleaseLabel.
tag
- a String
objectvoid setScmReleasedPomRevision(String scmRevision)
setScmReleasedPomRevision.
scmRevision
- a String
objectvoid setScmRelativePathProjectDirectory(String scmRelativePathProjectDirectory)
setScmRelativePathProjectDirectory.
scmRelativePathProjectDirectory
- a String
objectvoid setScmSourceUrl(String scmUrl)
setScmSourceUrl.
scmUrl
- a String
objectString getAutoResolveSnapshots()
String getLineSeparator()
boolean isPinExternals()
--pin-externals
option in svn copy
command is enabled
which is new in Subversion 1.9.Copyright © 2002–2024 The Apache Software Foundation. All rights reserved.