GitFlow Workflow

Understanding GitFlow

GitFlow is a branching model that provides a robust framework for managing larger projects. It defines a strict branching model designed around project releases.

Main Branches

GitFlow uses two main branches to record the history of the project. The main branch stores the official release history, while the develop branch serves as an integration branch for features.

# Initial setup
$  git flow init
 
# Configure main branches
$  git checkout main
$  git checkout -b develop
$  git push -u origin develop

Feature Branches

Feature branches are used to develop new features for the upcoming or a distant future release. They exist as long as the feature is in development.

# Start a new feature
$  git flow feature start my-feature
 
# Work on the feature...
$  git add .
$  git commit -m "Add new functionality"
 
# Finish the feature
$  git flow feature finish my-feature

Release Branches

Release branches support preparation of a new production release. They allow for minor bug fixes and preparing meta-data for a release.

# Start a release
$  git flow release start 1.0.0
 
# Make release preparations...
$  git add .
$  git commit -m "Bump version numbers"
 
# Finish the release
$  git flow release finish 1.0.0

Hotfix Branches

Hotfix branches are used to quickly patch production releases. These are similar to release branches but triggered by the need to act immediately upon an undesired state of a live production version.

# Start a hotfix
$  git flow hotfix start 1.0.1
 
# Fix the critical bug...
$  git add .
$  git commit -m "Fix critical production issue"
 
# Finish the hotfix
$  git flow hotfix finish 1.0.1

GitFlow Commands Summary

Here's a quick reference of common GitFlow commands for different operations:

# Initialize GitFlow
$  git flow init
 
# Feature branches
$  git flow feature start feature_name
$  git flow feature finish feature_name
$  git flow feature publish feature_name    # Share feature
$  git flow feature pull feature_name      # Get shared feature
 
# Release branches
$  git flow release start release_name
$  git flow release finish release_name
$  git flow release publish release_name
 
# Hotfix branches
$  git flow hotfix start hotfix_name
$  git flow hotfix finish hotfix_name

GitFlow Best Practices