Wiki
Clone wikijgit-flow / goals / hotfix-start
Hotfix Start
Full name: com.atlassian.maven.plugins:maven-jgitflow-plugin:1.0-m4:hotfix-start
Short name: jgitflow:hotfix-start
Description: Prepares the project for a hotfix. Creates a hotfix branch and updates poms with the hotfix 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. |
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 |
pushHotfixes | boolean | Whether to push hotfix branches to the remote upstream. Default value is: false. User property is: pushHotfixes. |
releaseVersion | String | Default version to use when starting a hotfix. User property is: releaseVersion. |
scmCommentPrefix | String | The message prefix to use for all SCM changes. Default value is: "" User property is: scmCommentPrefix. |
startCommit | String | A SHA, short SHA, or branch name to use as the starting point for the new branch User property is: startCommit. |
updateDependencies | boolean | Whether to update dependencies version to the hotfix version. Default value is: true. User property is: updateDependencies. |
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
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) |
pushHotfixes
Whether to push hotfix branches to the remote upstream.
- Type: boolean
- Required: no
- User Property: pushHotfixes
- Default: false
releaseVersion
Default version to use when starting a hotfix.
- Type: java.lang.String
- Required: no
- User Property: releaseVersion
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)
startCommit
A SHA, short SHA, or branch name to use as the starting point for the new branch
- Type: java.lang.String
- Required: no
- User Property: startCommit
updateDependencies
Whether to update dependencies version to the hotfix version.
- Type: boolean
- Required: no
- User Property: updateDependencies
- Default: true
Updated