Serialized Form

  • Package org.apache.maven.shared.release

    • Exception org.apache.maven.shared.release.ReleaseExecutionException

      class ReleaseExecutionException extends Exception implements Serializable
    • Exception org.apache.maven.shared.release.ReleaseFailureException

      class ReleaseFailureException extends Exception implements Serializable
  • Package org.apache.maven.shared.release.config

    • Class org.apache.maven.shared.release.config.ModelloReleaseDescriptor

      class ModelloReleaseDescriptor extends Object implements Serializable
      • Serialized Fields

        • activateProfiles
          List<String> activateProfiles
          Field activateProfiles.
        • additionalArguments
          String additionalArguments
          Additional arguments to pass to any executed Maven process.
        • addSchema
          boolean addSchema
          Whether to add the model schema to the top of the rewritten POM if it wasn't there already. If false then the root element will remain untouched.
        • allowTimestampedSnapshots
          boolean allowTimestampedSnapshots
          Should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.
        • autoResolveSnapshots
          String autoResolveSnapshots
          Specifies whether unresolved SNAPSHOT dependencies are automatically resolved. If set, it is used as the answer to use when being asked how unresolved SNAPSHOT dependencies should be resolved:
          • "all" or "0": resolve all kinds of snapshots, ie. project, plugin, report and extension dependencies
          • "dependencies" or "1": resolve project dependencies
          • "plugins" or "2": resolve plugin dependencies
          • "reports" or "3": resolve report dependencies
          • "extensions" or "4": resolve extension dependencies
          Additionally this implies that the default values for the dependency's release and next development version are used.
        • autoVersionSubmodules
          boolean autoVersionSubmodules
          Whether to use the parent pom version for submodule versions.
        • branchCreation
          boolean branchCreation
          Whether to create a branch instead of do a release.
        • checkModificationExcludes
          List<String> checkModificationExcludes
          Field checkModificationExcludes.
        • checkoutDirectory
          String checkoutDirectory
          The directory where the tag will be checked out.
        • commitByProject
          boolean commitByProject
          The commits must be done by modules or not. Set it to true in case of flat directory structure.
        • completedPhase
          String completedPhase
          The last completed phase.
        • completionGoals
          String completionGoals
          The goals to execute in on completion of preparation for the release.
        • defaultDevelopmentVersion
          String defaultDevelopmentVersion
          Default version to use for new working copy.
        • defaultReleaseVersion
          String defaultReleaseVersion
          Default version to use for the tagged release or the new branch.
        • description
          String description
          The description of this release configuration .
        • generateReleasePoms
          boolean generateReleasePoms
          Whether to generate release POMs.
        • interactive
          boolean interactive
          Whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.
        • lineSeparator
          String lineSeparator
          Specifies the line separator to use in the pom.xml.
        • localCheckout
          boolean localCheckout
          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!
        • modelEncoding
          String modelEncoding
          Field modelEncoding.
        • name
          String name
          The name of this release configuration .
        • originalScmInfo
          Map<String,org.apache.maven.model.Scm> originalScmInfo
          Field originalScmInfo.
        • performGoals
          String performGoals
          The goals to execute in perform phase for the release.
        • pinExternals
          boolean pinExternals
          Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9. NOTE : Currently only implemented with Subversion. (https://issues.apache.org/jira/browse/SCM-805) .
        • pomFileName
          String pomFileName
          The file name of the POM to pass to any executed Maven process.
        • preparationGoals
          String preparationGoals
          The goals to execute in preparation for the release.
        • projectNamingPolicyId
          String projectNamingPolicyId
          The role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
        • projectVersionPolicyConfig
          Object projectVersionPolicyConfig
          The optional config string for the VersionPolicy implementation used to calculate the project versions. The format of this depends on the specific VersionPolicy that is used.
        • projectVersionPolicyId
          String projectVersionPolicyId
          The role-hint for the VersionPolicy implementation used to calculate the project versions.
        • projectVersions
          Map<String,ReleaseStageVersions> projectVersions
          Field projectVersions
        • pushChanges
          boolean pushChanges
          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.
        • releaseStrategyId
          String releaseStrategyId
          The role-hint for the release Strategy implementation.
        • remoteTagging
          boolean remoteTagging
          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) .
        • resolvedSnapshotDependencies
          Map<String,ReleaseStageVersions> resolvedSnapshotDependencies
          Field resolvedSnapshotDependencies.
        • scmBranchBase
          String scmBranchBase
          Where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches .
        • scmBranchCommitComment
          String scmBranchCommitComment
          The SCM commit comment when branching .
        • ScmCommentPrefix
          String ScmCommentPrefix
          The prefix of SCM modification messages .
        • scmDevelopmentCommitComment
          String scmDevelopmentCommitComment
          The SCM commit comment when setting pom.xml back to development .
        • scmId
          String scmId
          The id can be used to get the credentials by the server-id from the settings.xml .
        • scmPassword
          String scmPassword
          The password for the user interacting with the scm .
        • scmPrivateKey
          String scmPrivateKey
          Private key for an SSH based SCM repository.
        • scmPrivateKeyPassPhrase
          String scmPrivateKeyPassPhrase
          Pass phrase for the private key.
        • scmRelativePathProjectDirectory
          String scmRelativePathProjectDirectory
          Relative path of the project returned by the checkout command.
        • scmReleaseCommitComment
          String scmReleaseCommitComment
          The SCM commit comment when setting pom.xml to release .
        • scmReleasedPomRevision
          String 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.
        • scmReleaseLabel
          String scmReleaseLabel
          tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0 .
        • scmRollbackCommitComment
          String scmRollbackCommitComment
          The SCM commit comment when rolling back .
        • scmShallowClone
          boolean scmShallowClone
          Get whether to use a shallow clone with no history or a full clone containing the full history during the release .
        • scmSignTags
          boolean scmSignTags
          If the scm provider should use sign tags, for example for git-exe the '--sign' argument would be used.
        • scmSourceUrl
          String 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
          String scmTagBase
          Where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags .
        • scmTagNameFormat
          String 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 } .
        • scmUseEditMode
          boolean scmUseEditMode
          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.
        • scmUsername
          String scmUsername
          The user name to interact with the scm .
        • snapshotReleasePluginAllowed
          boolean snapshotReleasePluginAllowed
          Whether a SNAPSHOT of the release plugin is allowed.
        • suppressCommitBeforeTagOrBranch
          boolean suppressCommitBeforeTagOrBranch
          Whether to suppress a commit of changes to the working copy before a tag or branch is created.
        • updateBranchVersions
          boolean updateBranchVersions
          Whether to update branch POM versions.
        • updateDependencies
          boolean updateDependencies
          If updateDependencies is false, dependencies version won't be updated to the next development version.
        • updateVersionsToSnapshot
          boolean updateVersionsToSnapshot
          Whether to update branch versions to SNAPSHOT.
        • updateWorkingCopyVersions
          boolean updateWorkingCopyVersions
          Whether to update working copy POM versions.
        • useReleaseProfile
          boolean useReleaseProfile
          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.
        • waitBeforeTagging
          int waitBeforeTagging
          Wait the specified number of seconds before creating a tag.
        • workingDirectory
          String workingDirectory
          The directory where the release is performed.
        • workItem
          String 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.
    • Class org.apache.maven.shared.release.config.ReleaseDescriptorBuilder.BuilderReleaseDescriptor

      class BuilderReleaseDescriptor extends ModelloReleaseDescriptor implements Serializable
    • Exception org.apache.maven.shared.release.config.ReleaseDescriptorStoreException

      class ReleaseDescriptorStoreException extends Exception implements Serializable
    • Class org.apache.maven.shared.release.config.ReleaseStageVersions

      class ReleaseStageVersions extends Object implements Serializable
      • Serialized Fields

        • development
          String development
          Field development.
        • original
          String original
          Field original.
        • release
          String release
          Field release.
  • Package org.apache.maven.shared.release.exec

  • Package org.apache.maven.shared.release.scm

  • Package org.apache.maven.shared.release.transform.jdom2

  • Package org.apache.maven.shared.release.util

  • Package org.apache.maven.shared.release.versions

    • Exception org.apache.maven.shared.release.versions.VersionComparisonConflictException

      class VersionComparisonConflictException extends RuntimeException implements Serializable
      • Serialized Fields

        • aetherComparisonResult
          int aetherComparisonResult
        • lhsVersion
          String lhsVersion
        • mavenComparisonResult
          int mavenComparisonResult
        • rhsVersion
          String rhsVersion
    • Exception org.apache.maven.shared.release.versions.VersionParseException

      class VersionParseException extends Exception implements Serializable