@britishcouncil/gitflow

A collection of Git extensions to provide high-level repository operations for Vincent Driessen's branching model

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
Minified + gzip package size for @britishcouncil/gitflow in KB

Readme

git-flow (BC Edition)

A collection of Git extensions to provide high-level repository operations for Vincent Driessen's branching model. This fork adds functionality not added to the original branch and includes support for Bitbucket.

Getting started

For the best introduction to get started with git flow, please read Jeff Kreeftmeijer's blog post:

http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/

Or have a look at one of these screen casts:

A quick cheatsheet was made by Daniel Kummer:

http://danielkummer.github.io/git-flow-cheatsheet/

Installing git-flow

Just install @britishcouncil/gitflow package globally via npm:

npm install -g @britishcouncil/gitflow

See the Wiki for more Installation Instructions.

Integration with your shell

For those who use the Bash or ZSH shell, you can use Peter van der Does' fork of git-flow-completion which includes several additions for git-flow (AVH Edition), or you can use the original git-flow-completion project by bobthecow. Both offer tab-completion for git-flow subcommands and branch names with Peter's fork including tab-completion for the commands not found in the original git-flow.

FAQ

  • See the FAQ section of the project Wiki.

git flow usage

Initialization

To initialize a new repo with the basic branch structure, use:

git flow init [-d]

This will then interactively prompt you with some questions on which branches you would like to use as development and production branches, and how you would like your prefixes be named. You may simply press Return on any of those questions to accept the (sane) default suggestions.

The -d flag will accept all defaults.

Screencast git flow init

Creating feature/release/hotfix/support branches

  • To list/start/finish/delete feature branches, use:
git flow feature
git flow feature start <name> [<base>]
git flow feature finish <name>
git flow feature delete <name>

For feature branches, the <base> arg must be a branch, when omitted it defaults to the develop branch.

  • To push/pull a feature branch to the remote repository, use:
git flow feature publish <name>
git flow feature track <name>
  • To list/start/finish/delete release branches, use:
git flow release
git flow release start <release> [<base>]
git flow release finish <release>
git flow release delete <release>

For release branches, the <base> arg must be a branch, when omitted it defaults to the develop branch.

  • To list/start/finish/delete hotfix branches, use:
git flow hotfix
git flow hotfix start <release> [<base>]
git flow hotfix finish <release>
git flow hotfix delete <release>

For hotfix branches, the <base> arg must be a branch, when omitted it defaults to the production branch.

  • To list/start support branches, use:
git flow support
git flow support start <release> <base>

For support branches, the <base> arg must be a branch, when omitted it defaults to the production branch.

Share features with others

You can easily publish a feature you are working on. The reason can be to allow other programmers to work on it or to access it from another machine. The publish/track feature of gitflow simplify the creation of a remote branch and its tracking.

When you want to publish a feature just use:

git flow feature publish <name>

or, if you already are into the feature/<name> branch, just issue:

git flow feature publish

Now if you execute git branch -avv you will see that your branch feature/<name> tracks [origin/feature/<name>]. To track the same remote branch in another clone of the same repository use:

git flow feature track <name>

This will create a local feature feature/<name> that tracks the same remote branch as the original one, that is origin/feature/<name>.

When one developer (depending on your work flow) finishes working on the feature he or she can issue git flow feature finish <name> and this will automatically delete the remote branch. All other developers shall then run:

    git flow feature delete <name>

to get rid of the local feature that tracks a remote branch that no more exist.

Using Hooks and Filters

For a wide variety of commands hooks or filters can be called before and after the command. The files should be placed in .git/hooks In the directory hooks you can find examples of all the hooks available.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.