README

Useful helper for using gitflow-like branching model in a project. It is a simple shell script that helps you to create, finish and publish branches in a git repository. It supports automatically bumping version tag and pushing from and to correct branches.

Check full documentation here: opensource.duma.sh/apps/git-flow

Installation

in your project install the tool by running:

composer require kduma/git-flow-tool

and then use it by running:

vendor/bin/git-flow-tool

Configuration

In root directory of your project create .git-flow-tool.json file with following content:

{
    "versionProvider": "php-array?filename=config/app.php&key=version",
    "gitFlow": "branch[develop]=develop&branch[master]=main&prefix[feature]=feature/&prefix[release]=release/&prefix[hotfix]=hotfix/&prefix[support]=support/&prefix[versionTag]=v&suffix[versionTag]=-src",
    "git": "author[name]=BOT&author[email]=bot@localhost"
}

Update it to match your project configuration.

Usage

vendor/bin/git-flow-tool release

or

vendor/bin/git-flow-tool hotfix