git-phlow

maintainer: groenborg

git phlow

tollgate	build	goreport	coveralls	issues

git-phlow (pronounced "git flow"), is a CLI extension for git, which provides an extra set of commands to easily use our pragmatic workflow called the phlow. It provides a branching model which makes collaboration easy. It also provides automatic issue tracking using GitHub issues with Waffle. The branching model uses branches prefixed with ready (can be configured) to mark delivered tasks to the remote repository from where automation services can pick up and integrate the changes into the stable branch.

Read about the pragmatic workflow, the phlow here.

git-phlows core features include:

• works with GitHub and waffle: git-phlow assigns labels to move around user stories on waffle boards, and managing your github issues.

• branches based on issues: workon creates a branch from a GitHub issues and moves it to "wip"

• issue tracking: having all your user stories as waffle cards or GitHub issues, git-phlow will mark them appropriately to their status.

• build for pretest integration: deliver pushes your branch to GitHub, ready for your pipeline to pull, integrate, test and merge back in.

Using the phlow (workflow)

To get started using the-phlow, read praqmas article about how the phlow works, and how to configure Waffle for your projects. A few things nees to be configured before hand:

• Activate issues on the designated GitHub repository
• Create the labels used by the phlow. Read the article above to find them
• Download and install git-phlow using brew or wget
• Start creating tasks in GitHub issues

Read the official documentation here

Installing git-phlow (tool)

Mac

If you have homebrew installed, you can tap our official repository.

# Tap our repository
brew tap praqma/praqma-tap

# Install git-phlow
brew install git-phlow

# Upgrade to a new version
brew upgrade git-phlow

Linux

Install git-phlow by running the following commands. Remember to use the latest version.

wget https://github.com/Praqma/git-phlow/releases/download/v2.3.2/git-phlow-2.3.2-linux-amd64.tar.gz && tar -xzf git-phlow-2.3.2-linux-amd64.tar.gz && mv git-phlow /usr/local/bin

Windows

Install with scoop, a package manager for command line tools. Or download the latest release

Install Scoop

Open powershell and get the latest release of scoop

iex (new-object net.webclient).downloadstring('https://get.scoop.sh')

Add Praqmas scoop-bucket

scoop bucket add praqma-tools https://github.com/praqma/scoop-praqma-tools.git

Install git-phlow

scoop install git-phlow

Compatibility

• Powershell v5.1+
• Command prompt - only with the --no-color flag

Updating git-phlow (tool)

Mac

On Mac using homebrew, run the upgrade command.

brew upgrade git-phlow

Linux

In linux you run the installation again, but this time override the old git-phlow binary.

Windows

On windows using scoop, run the update command

scoop update git-phlow

Usage

• First time, authenticate to GitHub:

git phlow auth

• Look at the issues by using ghi or going to GitHub or Waffle
• Find an issue to work on, and note its id e.g. 42
• Go to the local git repository and type:

git phlow workon 42

• This will create a branch: 42-some-issue-title
• Make the changes and complete the task
• When done, add everything and commit with a single command:

git phlow wrapup

• Now that the changes are ready, type:

git phlow deliver

• It renames the local branch to: delivered/42-some-issue-title
• It pushes remote branch named: ready/42-some-issue-title

If the automation tools have been configured to listen for ready/ branches, they will pick up the branch and integrate them with the stable branch. If you do not have an automation system, you can deliver the work to your default branch by doing a local deliver instead.

git phlow deliver --local

• Changes branch to master
• Merges changes from 42-some-issue-title
• Pushes changes to GitHub

Automation systems

We use Travis CI, Concourse CI and Jenkins. They can all be configured to follow the phlow and listen for ready branches. You can see the Concourse pipeline configured for this project here

git-phlow on Windows

We recommend running git-phlow using PowerShell. There are known issues with cmd rendering formatted text incorrect, and git bash's input being handled incorrectly.

Project status

This is the official repository for the git-phlow extension. The project is currently under development and many additions are still to come. but version 0.1.5 is available and stable for both linux and Mac.

Getting started

Know the phlow, know go To understand the-phlow read praqmas great story about what is is and how it works. read me, please!

Contribution

Contributions are welcome! Please read the contribution guide

CodeScene Analysis

Get more details at codescene.io.