Fork me on GitHub

smart-release:prepare

Full name:

de.hilling.maven.release:smart-release-plugin:4.1:prepare

Description:

Prepares the project release. This mojo will:
  • Check if the repository is clean.
  • Check which modules need to be released. This is accomplished by comparing the git history to the version information in .release-info.json
  • The corresponding poms are updated and the list of modules to build is stored in modules-to-build.txt
  • All files that should be cleaned up/reverted later are stored in files-to-revert.txt
  • The cleanup-mojo should later be used to revert these files.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Executes by direct invocation only.

Optional Parameters

Name Type Since Description
bugfixRelease boolean - Perform a bugfix release. When performing a bugfix release, the last ("bugfix") number of the release version is incremented. The previous releases are determined from the .release-info.json-File.
Default value is: false.
User property is: bugfixRelease.
disableSshAgent boolean - Disable use of the ssh agent.
User property is: disableSshAgent.
knownHosts String - If set, this file will be used to specify the known_hosts. This will override any default value.
User property is: knownHosts.
modulesToForceRelease List - Modules to force release on, even if no changes has been detected.
User property is: forceRelease.
noChangesAction NoChangesAction - Determines the action to take when no module changes are detected. Possible values: ReleaseAll, ReleaseNone, FailBuild
Default value is: ReleaseAll.
User property is: noChangesAction.
passphrase String - Specifies the passphrase to be used with the identityFile specified.
User property is: passphrase.
privateKey String - Specifies the private key to be used.
User property is: privateKey.
serverId String - If set, the identityFile and passphrase will be read from the Maven settings file.
User property is: serverId.

Parameter Details

bugfixRelease:

Perform a bugfix release. When performing a bugfix release, the last ("bugfix") number of the release version is incremented. The previous releases are determined from the .release-info.json-File.
  • Type: boolean
  • Required: No
  • User Property: bugfixRelease
  • Default: false

disableSshAgent:

Disable use of the ssh agent.
  • Type: boolean
  • Required: No
  • User Property: disableSshAgent

knownHosts:

If set, this file will be used to specify the known_hosts. This will override any default value.
  • Type: java.lang.String
  • Required: No
  • User Property: knownHosts

modulesToForceRelease:

Modules to force release on, even if no changes has been detected.
  • Type: java.util.List
  • Required: No
  • User Property: forceRelease

noChangesAction:

Determines the action to take when no module changes are detected. Possible values: ReleaseAll, ReleaseNone, FailBuild
  • Type: de.hilling.maven.release.NoChangesAction
  • Required: No
  • User Property: noChangesAction
  • Default: ReleaseAll

passphrase:

Specifies the passphrase to be used with the identityFile specified.
  • Type: java.lang.String
  • Required: No
  • User Property: passphrase

privateKey:

Specifies the private key to be used.
  • Type: java.lang.String
  • Required: No
  • User Property: privateKey

serverId:

If set, the identityFile and passphrase will be read from the Maven settings file.
  • Type: java.lang.String
  • Required: No
  • User Property: serverId