Wiki

Clone wiki

jgit-flow / goals / feature-finish

Feature Finish

Full name: com.atlassian.maven.plugins:maven-jgitflow-plugin:1.0-m4:feature-finish

Short name: jgitflow:feature-finish

Description: Finishes the feature. Builds the project, Merges the feature branch (as per git-flow), and updates pom(s) to previous develop version

Attributes:

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

Configuration

NameTypeDescription
allowUntrackedbooleanWhether to allow untracked files when checking if the working tree is clean.
Default value is: false.
User property is: allowUntracked.
defaultOriginUrlStringDefault url to use if origin remote is not found in .git/config.
User property is: defaultOriginUrl.
enableFeatureVersionsbooleanWhether to append the feature name to the version on the feature branch.
Default value is: false
User property is: enableFeatureVersions
enableSshAgentbooleanWhether to enable using an ssh-agent.
Default value is: false.
User property is: enableSshAgent.
featureNameStringThe name of the new feature branch.
User property is: featureName.
featureRebasebooleanWhether to rebase the feature branch before merging.
Default value is: false.
User property is: featureRebase.
flowInitContextFlowInitContextUsed to override default git-flow branch names and prefixes
keepBranchbooleanWhether to keep the feature branch after finishing the feature.
Default value is: false.
User property is: keepBranch.
noFeatureBuildbooleanWhether to turn off project building. If true the project will NOT be built during feature finish
Default value is: false.
User property is: noFeatureBuild.
noFeatureMergebooleanWhether to turn off merging changes from the feature branch to develop
Default value is: false.
User property is: noFeatureMerge.
pushFeaturesbooleanWhether to push feature branches to the remote upstream.
Default value is: false.
User property is: pushFeatures.
scmCommentPrefixStringThe message prefix to use for all SCM changes.
Default value is: ""
User property is: scmCommentPrefix.
squashbooleanWhether to squash commits into a single commit before merging.
Default value is: false.
User property is: squash.

Parameter Details

allowUntracked

Whether to allow untracked files when checking if the working tree is clean.

  • Type: boolean
  • Required: no
  • User Property: allowUntracked
  • Default: false

enableFeatureVersions

Whether to append the feature name to the version on the feature branch.

  • Type: boolean
  • Required: no
  • User Property: enableFeatureVersions
  • 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

featureName

Name for the new feature branch

  • Type: java.lang.String
  • Required: no
  • User Property: featureName

featureRebase

Whether to rebase the feature branch before merging.

  • Type: boolean
  • Required: no
  • User Property: featureRebase
  • Default: false

flowInitContext

  • Type: com.atlassian.maven.plugins.jgitflow.FlowInitContext
  • Required: no
  • Default: ${flowInitContext}

Object Properties

NameTypeDescription
masterBranchNameStringThe name of the master branch.
Default value is: master
developBranchNameStringThe name of the development branch.
Default value is: develop
featureBranchPrefixStringThe prefix for feature branches
Default value is: feature/
releaseBranchPrefixStringThe prefix for release branches
Default value is: release/
hotfixBranchPrefixStringThe prefix for hotfix branches
Default value is: hotfix/
versionTagPrefixStringThe prefix for release tags
Default value is: (blank)

keepBranch

Whether to keep the feature branch after finishing the feature.

  • Type: boolean
  • Required: no
  • User Property: keepBranch
  • Default: false

noFeatureBuild

Whether to turn off project building. If true the project will NOT be built during feature finish

  • Type: boolean
  • Required: no
  • User Property: noFeatureBuild
  • Default: false

noFeatureMerge

Whether to turn off merging changes from the release branch to develop

  • Type: boolean
  • Required: no
  • User Property: noFeatureMerge
  • Default: false

pushFeatures

Whether to push feature branches to the remote upstream.

  • Type: boolean
  • Required: no
  • User Property: pushFeatures
  • 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

Updated