ggitflow:release-finish

Full name:

com.dkirrane.maven.plugins:ggitflow-maven-plugin:1.5-SNAPSHOT:release-finish

Description:

Merges a release branch back into the develop and master branch and then creates a tag for the release on master.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.

Optional Parameters

Name Type Since Description
allowSnapshots Boolean 1.2 If true, the release can still finish even if -SNAPSHOT dependencies exists in the pom.
Default value is: false.
User property is: allowSnapshots.
includes String 1.5 If updateDependencies is set, then this should contain a comma separated list of artifact patterns to include. Follows the pattern groupId:artifactId:type:classifier:version
User property is: includes.
keep Boolean 1.2 If true, the branch will not be deleted after the merge.
Default value is: false.
User property is: keep.
msgPrefix String 1.2 Message prefix used for any commits made by this plugin.
User property is: msgPrefix.
msgSuffix String 1.2 Message suffix used for any commits made by this plugin.
User property is: msgSuffix.
prefixes Prefixes 1.2 Gitflow branches and prefixes to use.
Default value is: ${prefixes}.
pushReleases boolean 1.2 If true, the release branch is pushed to the remote repository.
Default value is: false.
User property is: pushReleases.
releaseName String 1.2 The name for the release branch.
User property is: releaseName.
releaseProfiles String 1.2 Comma separated profiles to enable on deployment, in addition to active profiles for project execution.
User property is: releaseProfiles.
sign Boolean 1.2 If true, the release tag will be signed.
Default value is: false.
User property is: sign.
signingkey String 1.2 The GNU Privacy Guard (GPG) private key used to sign the tag.
User property is: signingkey.
skipBuild Boolean 1.2 Skips any calls to mvn install
Default value is: false.
User property is: skipBuild.
skipDeploy Boolean 1.2 Skips any calls to mvn deploy
Default value is: false.
User property is: skipDeploy.
skipTests Boolean 1.2 Skips any tests during mvn install and mvn deploy
Default value is: false.
User property is: skipTests.
squash Boolean 1.2 If true, all commits to the branch will be squashed into a single commit before the merge.
Default value is: false.
User property is: squash.
updateDependencies Boolean 1.2 On the release branch before finish is called any dependencies with a -SNAPSHOT version are replaced with the corresponding release version (if it has been released). On the develop branch after the merge any dependencies with a release version are replaced with the next -SNAPSHOT version (if it has been deployed).
Default value is: true.
User property is: updateDependencies.
updateParent Boolean 1.2 If the project has a parent with a release version it will be replaced with the next -SNAPSHOT version (if it has been deployed). This action is performed on the develop branch after the merge.
Default value is: true.
User property is: updateParent.
useReleaseProfile Boolean 1.2 Whether to use the release profile that adds sources and javadoc to the released artifact, if appropriate. If set to true, the release-finish will set the property "performRelease" to true, which activates the profile "release-profile", which is inherited from the super pom.
Default value is: true.
User property is: useReleaseProfile.

Parameter Details

allowSnapshots:

If true, the release can still finish even if -SNAPSHOT dependencies exists in the pom.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: allowSnapshots
  • Default: false

includes:

If updateDependencies is set, then this should contain a comma separated list of artifact patterns to include. Follows the pattern groupId:artifactId:type:classifier:version
  • Type: java.lang.String
  • Since: 1.5
  • Required: No
  • User Property: includes

keep:

If true, the branch will not be deleted after the merge.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: keep
  • Default: false

msgPrefix:

Message prefix used for any commits made by this plugin.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: msgPrefix

msgSuffix:

Message suffix used for any commits made by this plugin.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: msgSuffix

prefixes:

Gitflow branches and prefixes to use.
  • Type: com.dkirrane.maven.plugins.ggitflow.Prefixes
  • Since: 1.2
  • Required: No
  • Default: ${prefixes}

pushReleases:

If true, the release branch is pushed to the remote repository.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: pushReleases
  • Default: false

releaseName:

The name for the release branch.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: releaseName

releaseProfiles:

Comma separated profiles to enable on deployment, in addition to active profiles for project execution.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: releaseProfiles

sign:

If true, the release tag will be signed.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: sign
  • Default: false

signingkey:

The GNU Privacy Guard (GPG) private key used to sign the tag.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: signingkey

skipBuild:

Skips any calls to mvn install
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: skipBuild
  • Default: false

skipDeploy:

Skips any calls to mvn deploy
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: skipDeploy
  • Default: false

skipTests:

Skips any tests during mvn install and mvn deploy
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: skipTests
  • Default: false

squash:

If true, all commits to the branch will be squashed into a single commit before the merge.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: squash
  • Default: false

updateDependencies:

On the release branch before finish is called any dependencies with a -SNAPSHOT version are replaced with the corresponding release version (if it has been released). On the develop branch after the merge any dependencies with a release version are replaced with the next -SNAPSHOT version (if it has been deployed).
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: updateDependencies
  • Default: true

updateParent:

If the project has a parent with a release version it will be replaced with the next -SNAPSHOT version (if it has been deployed). This action is performed on the develop branch after the merge.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: updateParent
  • Default: true

useReleaseProfile:

Whether to use the release profile that adds sources and javadoc to the released artifact, if appropriate. If set to true, the release-finish will set the property "performRelease" to true, which activates the profile "release-profile", which is inherited from the super pom.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: useReleaseProfile
  • Default: true