gitflow README

The project's README from github.com/nvie/gitflow. As one markdown file: README.md.

[!IMPORTANT]

⚠️ git-flow has moved to git-flow-next!

This repository is no longer maintained. The wonderful team at Tower has created git-flow-next — a modern, fully customizable evolution of git-flow, built on a generic branch dependency model. It’s fully backward compatible with git-flow, open source, and actively maintained.

Get started with git-flow-next:

Why git-flow-next?

git-flow-next builds upon the foundation laid by the original git-flow, offering:

  • Full customization of branch names and workflow
  • Modern implementation with active maintenance
  • Backward compatibility with existing git-flow workflows
  • Upcoming features like stacked branches and topic branch syncing

Thank you ❤️

To everyone who has used, contributed to, and supported git-flow over the past 15+ years — thank you! Your feedback, contributions, and adoption made git-flow one of the most widely-used Git workflow tools. Special thanks to Peter van der Does for maintaining git-flow-avh, and to the folks at Tower for carrying the torch forward with git-flow-next.


(Below, you’ll find the original documentation for historical reference.)


git-flow

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

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:

Installing git-flow

See the Wiki for up-to-date Installation Instructions.

Integration with your shell

For those who use the Bash or ZSH shell, please check out the excellent work on the git-flow-completion project by bobthecow. It offers tab-completion for all git-flow subcommands and branch names.

FAQ

See the FAQ section of the project Wiki.

License terms

git-flow 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.

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.

Creating feature/release/hotfix/support branches

gitflow (nvie/gitflow)

Searching Database…

26.8K ·GitHub
archived
What is this?A collection of Git extensions that implement Vincent Driessen's branching model, adding high-level commands for managing feature, release, hotfix and support branches on top of plain git.
Is this a standalone app or does it work through git itself?It's not a separate app; it's a shell script that adds a 'git flow' subcommand, so you use it exactly like any other git command inside your existing repo.
How do I start using git-flow on a repository?Run 'git flow init' (or 'git flow init -d' to accept all defaults) inside a git repo; it interactively asks which branches to use for development and production and how to name prefixes.
Do I need anything besides git itself?Just git and a shell; Bash/ZSH users can optionally add the separate 'git-flow-completion' project by bobthecow for tab-completion of subcommands and branch names.
Is this project still maintained?No, the repository is archived and no longer maintained. The author points users to 'git-flow-next', a modern, actively maintained, backward-compatible successor built by the Tower team.
What kinds of branches does git-flow manage?It manages feature, release, hotfix, and support branches, each with its own start/finish/publish/pull commands tied to specific base branches like develop or master.
Why was git-flow deprecated in favor of git-flow-next?git-flow-next, built by Tower, offers full customization of branch names and workflow, a modern actively-maintained implementation, backward compatibility with existing git-flow repos, and upcoming features like stacked branches.
Can I get shell tab-completion for git-flow commands?Yes, Bash and ZSH users can install the separate git-flow-completion project (by bobthecow) for tab-completion of subcommands and branch names.
What are similar projects?git-extras, autojump, just, cz-cli, lazygit, epiq, prezto, oh-my-posh
Creator
nvie
Size
0.5 MB
Stars
26.8K
Updated
CommitOct 14
Age
16y
Commits · 90 Days