ggitflow:release-start

Full name:

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

Description:

Creates a new release branch off of the develop branch.

Attributes:

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

Optional Parameters

Name Type Since Description
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.
interactive boolean 1.2 Whether to run the plugin in interactive mode or not. The default is to run without interaction when possible.
Default value is: true.
User property is: interactive.
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.
startCommit String 1.2 The commit to start the release branch from.
User property is: startCommit.
updateDependencies boolean 1.2 Any dependencies with a -SNAPSHOT version are replaced with the corresponding release version (if it has been released). This action is performed on the release branch after it is created.
Default value is: false.
User property is: updateDependencies.
updateParent boolean 1.2 If the project has a parent with a -SNAPSHOT version it will be replaced with the corresponding release version (if it has been released). This action is performed on the release branch after it is created.
Default value is: false.
User property is: updateParent.

Parameter Details

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

interactive:

Whether to run the plugin in interactive mode or not. The default is to run without interaction when possible.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: interactive
  • Default: true

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

startCommit:

The commit to start the release branch from.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: startCommit

updateDependencies:

Any dependencies with a -SNAPSHOT version are replaced with the corresponding release version (if it has been released). This action is performed on the release branch after it is created.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: updateDependencies
  • Default: false

updateParent:

If the project has a parent with a -SNAPSHOT version it will be replaced with the corresponding release version (if it has been released). This action is performed on the release branch after it is created.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: updateParent
  • Default: false