Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 4.4 KB

README.md

File metadata and controls

90 lines (63 loc) · 4.4 KB
Raw

Git-Flow Maven Plugin

The Maven plugin for Vincent Driessen's successful Git branching model.

Currently a Java implementation of Git version control system JGit doesn't support .gitattributes.

This plugin runs Git and Maven commands from the command line ensuring that all Git features work properly.

Changelog

See what's changed - CHANGELOG

Installation

The plugin is available from Maven central.

<build>
    <plugins>
        <plugin>
            <groupId>com.amashchenko.maven.plugin</groupId>
            <artifactId>gitflow-maven-plugin</artifactId>
            <version>1.0.8</version>
            <configuration>
                <!-- optional configuration -->
            </configuration>
        </plugin>
    </plugins>
</build>

Goals Overview

  • gitflow:release-start - Starts a release branch and updates pom(s) with release version.
  • gitflow:release-finish - Merges a release branch and updates pom(s) with next development version.
  • gitflow:feature-start - Starts a feature branch and updates pom(s) with feature name.
  • gitflow:feature-finish - Merges a feature branch.
  • gitflow:hotfix-start - Starts a hotfix branch and updates pom(s) with hotfix version.
  • gitflow:hotfix-finish - Merges a hotfix branch.
  • gitflow:help - Displays help information on plugin.

Plugin Common Parameters

All parameters are optional. The gitFlowConfig parameters defaults are the same as in below example. Maven and Git executables are assumed to be in the PATH, if executables are not available in the PATH or you want to use different version use mvnExecutable and gitExecutable parameters. The installProject parameter controls whether the Maven install goal will be called during the mojo execution. The default value for this parameter is false (i.e. the project will NOT be installed). Since 1.0.7 version of this plugin the output of the executed commands will NOT be printed into the console. This can be changed by setting verbose parameter to true.

<configuration>
    <mvnExecutable>path_to_maven_executable</mvnExecutable>
    <gitExecutable>path_to_git_executable</gitExecutable>

    <installProject>false</installProject>
    <verbose>false</verbose>

    <gitFlowConfig>
        <productionBranch>master</productionBranch>
        <developmentBranch>develop</developmentBranch>
        <featureBranchPrefix>feature/</featureBranchPrefix>
        <releaseBranchPrefix>release/</releaseBranchPrefix>
        <hotfixBranchPrefix>hotfix/</hotfixBranchPrefix>
        <supportBranchPrefix>support/</supportBranchPrefix>
        <versionTagPrefix></versionTagPrefix>
    </gitFlowConfig>
</configuration>

Additional goal parameters

The gitflow:release-finish and gitflow:hotfix-finish goals have skipTag parameter. This parameter controls whether the release/hotfix will be tagged in Git. The default value is false (i.e. the release/hotfix will be tagged).

The gitflow:feature-start goal has skipFeatureVersion parameter which controls whether the feature name will be appended to the project version or not. The default value is false (e.g. if the project version is 1.0.0-SNAPSHOT and feature name is feature_name then after the execution it will be 1.0.0-feature_name-SNAPSHOT).

All -finish goals have keepBranch parameter which controls whether created support branch will be kept in Git after the goal finishes. The default value is false (i.e. the supporting branch will be deleted).

All -finish goals have skipTestProject parameter which controls whether Maven test goal will be called before merging branches. The default value is false (i.e. the project will be tested before merging branches).

Non-interactive Release

Releases could be performed without prompting for the release version during gitflow:release-start goal by telling Maven to run in non-interactive (batch) mode. When gitflow:release-start is executed in the Maven batch mode the default release version will be used.

To put Maven in the batch mode use -B or --batch-mode option.

mvn -B gitflow:release-start gitflow:release-finish

This gives the ability to perform releases in non-interactive mode (e.g. in CI server).