Wiki
Clone wikijgit-flow / goals / hotfix-finish
Hotfix Finish
Full name: com.atlassian.maven.plugins:maven-jgitflow-plugin:1.0-m4:hotfix-finish
Short name: jgitflow:hotfix-finish
Description: Releases the project. Builds the project, Merges the hotfix branch (as per git-flow), optionally pushes changes and updates pom(s) to previous version
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator plugin.
Configuration
Name | Type | Description |
---|---|---|
allowSnapshots | boolean | Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT. Default value is: false User property is: allowSnapshots |
allowUntracked | boolean | Whether to allow untracked files when checking if the working tree is clean. Default value is: false. User property is: allowUntracked. |
autoVersionSubmodules | boolean | Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the version of each submodules. Default value is: false. User property is: autoVersionSubmodules. |
defaultOriginUrl | String | Default url to use if origin remote is not found in .git/config. User property is: defaultOriginUrl. |
developmentVersion | String | Default development version to use when finishing a hotfix. User property is: developmentVersion. |
enableSshAgent | boolean | Whether to enable using an ssh-agent. Default value is: false. User property is: enableSshAgent. |
flowInitContext | FlowInitContext | Used to override default git-flow branch names and prefixes |
keepBranch | boolean | Whether to keep the hotfix branch after finishing the hotfix. Default value is: false. User property is: keepBranch. |
noDeploy | boolean | Whether to turn off maven deployment. If false the "deploy" goal is called. If true the "install" goal is called Default value is: false. User property is: noDeploy. |
noHotfixBuild | boolean | Whether to turn off project building. If true the project will NOT be built during hotfix finish Default value is: false. User property is: noHotfixBuild. |
noTag | boolean | Whether to turn off tagging the hotfix in git. Default value is: false. User property is: noTag. |
pushHotfixes | boolean | Whether to push hotfix branches to the remote upstream. Default value is: false. User property is: pushHotfixes. |
scmCommentPrefix | String | The message prefix to use for all SCM changes. Default value is: "" User property is: scmCommentPrefix. |
squash | boolean | Whether to squash commits into a single commit before merging. Default value is: false. User property is: squash. |
tagMessage | String | Commit message to use when tagging the hotfix. Default value is: "tagging release ${version}". |
updateDependencies | boolean | Whether to update dependencies version to the development version. Default value is: true. User property is: updateDependencies. |
useReleaseProfile | boolean | Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, the plugin sets 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
Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT.
- Type: boolean
- Required: no
- User Property: allowSnapshots
- Default: false
allowUntracked
Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT.
- Type: boolean
- Required: no
- User Property: allowSnapshots
- Default: false
autoVersionSubmodules
Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the version of each submodules.
- Type: boolean
- Required: no
- User Property: autoVersionSubmodules
- Default: false
defaultOriginUrl
Default url to use if origin remote is not found in .git/config.
This can be any acceptable git url that you would normally put in .git/config
- Type: java.lang.String
- Required: no
- User Property: defaultOriginUrl
developmentVersion
Default development version to use when finishing a hotfix.
- Type: java.lang.String
- Required: no
- User Property: developmentVersion
enableSshAgent
Whether to enable using an ssh-agent
- Type: boolean
- Required: no
- User Property: enableSshAgent
- Default: false
flowInitContext
- Type: com.atlassian.maven.plugins.jgitflow.FlowInitContext
- Required: no
- Default: ${flowInitContext}
Object Properties
Name | Type | Description |
---|---|---|
masterBranchName | String | The name of the master branch. Default value is: master |
developBranchName | String | The name of the development branch. Default value is: develop |
featureBranchPrefix | String | The prefix for feature branches Default value is: feature/ |
releaseBranchPrefix | String | The prefix for release branches Default value is: release/ |
hotfixBranchPrefix | String | The prefix for hotfix branches Default value is: hotfix/ |
versionTagPrefix | String | The prefix for release tags Default value is: (blank) |
keepBranch
Whether to keep the hotfix branch after finishing the hotfix.
- Type: boolean
- Required: no
- User Property: keepBranch
- Default: false
noDeploy
Whether to turn off maven deployment. If false the "deploy" goal is called. If true the "install" goal is called
- Type: boolean
- Required: no
- User Property: noDeploy
- Default: false
noHotfixBuild
Whether to turn off project building. If true the project will NOT be built during hotfix finish
- Type: boolean
- Required: no
- User Property: noHotfixBuild
- Default: false
noTag
Whether to turn off tagging the hotfix in git. |
- Type: boolean
- Required: no
- User Property: noTag
- Default: false
pushHotfixes
Whether to push hotfix branches to the remote upstream.
- Type: boolean
- Required: no
- User Property: pushHotfixes
- Default: false
scmCommentPrefix
The message prefix to use for all SCM changes. Will be appended as is. e.g. getScmMessagePrefix() + the_message;
- Type: java.lang.String
- Required: no
- User Property: scmCommentPrefix
- Default: "" (no prefix)
squash
Whether to squash commits into a single commit before merging.
- Type: boolean
- Required: no
- User Property: squash
- Default: false
tagMessage
Commit message to use when tagging the hotfix.
- Type: java.lang.String
- Required: no
- Default: "tagging release ${version}"
updateDependencies
Whether to update dependencies version to the development version.
- Type: boolean
- Required: no
- User Property: updateDependencies
- Default: true
useReleaseProfile
Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, the plugin sets the property "performRelease" to true, which activates the profile "release-profile", which is inherited from the super pom.
- Type: boolean
- Required: no
- User Property: useReleaseProfile
- Default: true
Updated