Skip to content

HubFlow (WebSharks Flavor): A Git extension to make it easy to use GitFlow with GitHub. Based on the original gitflow extension for git.

License

Notifications You must be signed in to change notification settings

wpsharks/hubflow

 
 

Repository files navigation

HubFlow (WebSharks Flavor)

Adds the 'git hf' Git extension to provide high-level repository operations for DataSift's HubFlow branching model, which is based on Vincent Driessen’s original blog post. See also: WebSharks Flavor Changes.

Installation (WebSharks Flavor)

Mac via Homebrew (recommended)

brew tap websharks/formulas
brew install websharks-hubflow

All Other Operating Systems

  1. git clone https://github.com/websharks/hubflow.git
  2. cd hubflow && git checkout master
  3. sudo ./install.sh

Windows users will need something like Cygwin in order to use this extension.

Upgrading To The Latest Version

Upgrading to the latest version of the HubFlow tools is very easy:

Mac via Homebrew (recommended)

brew update
brew upgrade websharks-hubflow

All Other Operating Systems

  1. sudo git hf upgrade

Getting Started

See our tutorial website to learn more about the GitFlow branching model and how to use the HubFlow tools.

Changelog

To see what's new in each release, see our Changelog.

WebSharks Flavor Changes

  • Added support for an additional synchronized repo that rides with the primary.
  • Added a scan for an existing dev branch; if it exists we use this over the default name: develop for the "next release" branch.

Repo Synchronization

To enable the synchronization functionality (i.e. if you have both a lite/pro version you are maintaining together); use the s flag.

Example...

From your repo directory...

$ git hf init -asf

Usage...

From your repo directory...

$ git hf init -asf

... just fill in the blanks where it asks for your configuration. Most of it can just be left with the default values. To clarify, there are three flags here. a = ask for configuration values, s = enable synchronization functionality (optional), and f = force a new set of config values, overriding any that already exist. I recommend always using these flags together; i.e. git hf init -asf

NOTE: If you enable the s flag (synchronization) you will be asked for two config sets. That's normal. In synchronization mode all of your commands are duplicated across two repos.

Once you are configured, you can do this...

$ git hf feature start 123

... where 123 is a GitHub issue that is connected to a feature branch.

License Terms

HubFlow is published under the liberal terms of the BSD License, see the LICENSE file. Although the BSD License does not require you to share any modifications you make to the source code, you are very much encouraged and invited to contribute back your modifications to the community, preferably in a Github fork, of course.

About

HubFlow (WebSharks Flavor): A Git extension to make it easy to use GitFlow with GitHub. Based on the original gitflow extension for git.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 100.0%