Karls.Gitflow.Tool 0.0.14

Git flow commands as a global .NET tool

A modern .NET command-line tool for managing Git branches using the Gitflow branching model. This tool is a reimplementation of parts of gitflow-avh. It isn't 100% compatible, but provides similar functionality with some additional features.

Installation

To install the Karls.Gitflow tool globally, run the following command:

dotnet tool install -g Karls.Gitflow.Tool

Note: If other git flow tools are installed, they may take precedence in your PATH.

Usage

Initialize Gitflow

# Interactive initialization
git flow init

# Use default settings
git flow init -d

# Specify options
git flow init --main main --develop develop

Feature Branches

Feature branches are used to develop new features and are branched off from the develop branch. They are merged back into develop when finished.

# List all feature branches
git flow feature list

# Start a new feature
git flow feature start my-feature

# Finish a feature (merges to develop)
git flow feature finish my-feature

# Publish feature to remote
git flow feature publish my-feature

# Delete a feature branch
git flow feature delete my-feature

Release Branches

Release branches are used to prepare for a new production release. They are branched off from develop and merged into both main and develop when finished. A tag is also created on main.

# Start a release
git flow release start 1.0.0

# Finish a release (merges to main AND develop, creates tag)
git flow release finish 1.0.0 -m "Release 1.0.0"

# Publish release to remote
git flow release publish 1.0.0

Hotfix Branches

Hotfix branches are used to quickly patch production releases. They are branched off from main and merged into both main and develop when finished. A tag is also created on main.

# Start a hotfix from main
git flow hotfix start 1.0.1

# Finish a hotfix (merges to main AND develop, creates tag)
git flow hotfix finish 1.0.1 -m "Hotfix 1.0.1"

Custom features

Push Command

The git flow push command pushes the main and develop branches, along with all tags, to the remote repository. This is useful for ensuring that your local changes are reflected in the remote repository after finishing releases or hotfixes.

# Push main, develop, and tags to remote
git flow push

Tag Message Template

When finishing releases or hotfixes, you can now set a custom tag message template using the configuration option tagmessage. This allows you to customize the message associated with tags created during these operations without needing to specify it each time.

# Set a custom tag message template
git flow config set tagmessage "Version {version} released on {date}"

When you finish a release or hotfix, the {version} placeholder will be replaced with the version number, and {date} will be replaced with the current date.