Skip to content

The official repository for the git-phlow extension

License

Notifications You must be signed in to change notification settings

devx-cafe/git-phlow

Repository files navigation

Test-integration - Build - Test - Deliver Go Report Card

git phlow

Git-phlow (pronounced "git flow"), is a CLI extension for git, which provides an extra set of commands to easily use our pragmatic workflow by the same name, Git phlow. It provides a branching model which makes collaboration easy. It also provides automatic issue tracking using GitHub issues.

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.

  • works with jira: sets assignee and does transition

  • branches based on issues: create a workspace from an issue to ensure traceability

  • fully automatable: deliver your branches, ready for your pipeline to integrate, test and merge

Getting started

To get started using this git extension we recommend to read the blogpost about Git-phlow and the entire automated workflow.

Otherwise follow these 3 simple steps to get up and running

  1. Get the tool Download from github releases

  2. Go to your project and create a configuration. You can use the default generated by the git-phlow

git phlow --init # create a new .gitconfig file with a sane set of defaults
  1. start using the workflow
git phlow workon <issue>

#Add changes

git phlow wrapup

git phlow deliver

Automation systems

We use Travis CI, Concourse CI and Jenkins. They can all be configured to follow git phlow. You can see the Concourse pipeline configured for Git-phlow here

git-phlow on Windows

git-phlow works in PowerShell on windows. 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 stable at version 3.8.2 for both windows, macOS and linux.

Contribution

Contributions are welcome! Please read the contribution guide