Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 120 lines (79 sloc) 3.887 kB
6c2d30b @nvie Structurally replace gitflow by git-flow, as a true git extension.
authored
1 git-flow
2 ========
12c4ab4 @nvie Update README file to mention new available features.
authored
3 A collection of Git extensions to provide high-level repository operations
4fc0bc1 @nvie Use a more friendly URL for the original blog post URL.
authored
4 for Vincent Driessen's [branching model](http://nvie.com/git-model "original
78c73dc @nvie Add initial project outline and guidelines.
authored
5 blog post").
6
7
12c4ab4 @nvie Update README file to mention new available features.
authored
8 Installing git-flow
9 -------------------
4f0f539 @nvie Added Rick Osborne's super-easy gitflow installer oneliner to the pro…
authored
10 The easiest way to install git-flow is using Rick Osborne's excellent
11 git-flow installer, which can be run using the following command:
12
13 $ wget -q -O - http://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | sudo sh
14
15 If you prefer a manual installation, please use the following instructions.
13c9482 @nvie Added instructions to first fetch submodules before installing.
authored
16 After downloading the sources from Github, also fetch the submodules:
17
18 $ git submodule init
19 $ git submodule update
20
21 Then, you can install `git-flow`, using:
78c73dc @nvie Add initial project outline and guidelines.
authored
22
12c4ab4 @nvie Update README file to mention new available features.
authored
23 $ sudo make install
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
24
e0b54c0 @nvie Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
authored
25 By default, git-flow will be installed in /usr/local. To change the prefix
26 where git-flow will be installed, simply specify it explicitly, using:
12c4ab4 @nvie Update README file to mention new available features.
authored
27
e0b54c0 @nvie Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
authored
28 $ sudo make prefix=/opt/local install
dd720be @nvie Dynamically collect the true git exec path and only if that can not b…
authored
29
30 Or simply point your `PATH` environment variable to your git-flow checkout
31 directory.
78c73dc @nvie Add initial project outline and guidelines.
authored
32
33
ec0b854 @nvie Add link to git-flow-completion project.
authored
34 Integration with your shell
35 ---------------------------
36 For those who use the [Bash](http://www.gnu.org/software/bash/) shell, please
37 check out the excellent work on the
38 [git-flow-completion](http://github.com/bobthecow/git-flow-completion) project
39 by [bobthecow](http://github.com/bobthecow). It offers tab-completion for all
40 git-flow subcommands and branch names.
41
42 If you are a [zsh](http://www.zsh.org) user with some plugin-writing
43 experience, please help us develop a
44 [completion plugin](http://github.com/bobthecow/git-flow-completion/issues#issue/1)
45 for zsh, too. Please contact me on [Github](http://github.com/inbox/new/nvie)
46 or [Twitter](http://twitter.com/nvie) to discuss details.
47
48
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
49 Please help out
50 ---------------
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
51 This project is still under development. Feedback and suggestions are very
52 welcome and I encourage you to use the [Issues
53 list](http://github.com/nvie/gitflow/issues) on Github to provide that
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
54 feedback.
55
d79a0d4 @nvie Added referral link to the AUTHORS file.
authored
56 Feel free to fork this repo and to commit your additions. For a list of all
57 contributors, please see the [AUTHORS](AUTHORS) file.
78c73dc @nvie Add initial project outline and guidelines.
authored
58
1fd5bcf @nvie Added link to Google group.
authored
59 Any questions, tips, or general discussion can be posted to our Google group:
1911101 @nvie Fix markdown issue.
authored
60 http://groups.google.com/group/gitflow-users
1fd5bcf @nvie Added link to Google group.
authored
61
78c73dc @nvie Add initial project outline and guidelines.
authored
62
5d1dbe7 @nvie Added (BSD) licensing terms to the project.
authored
63 License terms
64 -------------
65 git-flow is published under the liberal terms of the BSD License, see the
66 [LICENSE](LICENSE) file. Although the BSD License does not require you to share
67 any modifications you make to the source code, you are very much encouraged and
68 invited to contribute back your modifications to the community, preferably
69 in a Github fork, of course.
70
71
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
72 Typical usage:
73 --------------
74
75 ### Initialization
78c73dc @nvie Add initial project outline and guidelines.
authored
76
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
77 To initialize a new repo with the basic branch structure, use:
12c4ab4 @nvie Update README file to mention new available features.
authored
78
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
79 git flow init
f9ebb07 @nvie Added 'git flow init' to the README file.
authored
80
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
81 This will then interactively prompt you with some questions on which branches
82 you would like to use as development and production branches, and how you
83 would like your prefixes be named. You may simply press Return on any of
84 those questions to accept the (sane) default suggestions.
85
86
87 ### Creating feature/release/hotfix/support branches
12c4ab4 @nvie Update README file to mention new available features.
authored
88
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
89 * To list/start/finish feature branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
90
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
91 git flow feature
92 git flow feature start <name> [<base>]
93 git flow feature finish <name>
78c73dc @nvie Add initial project outline and guidelines.
authored
94
010252a @nvie Added an optional <base> argument to all start subactions.
authored
95 For feature branches, the `<base>` arg must be a commit on `develop`.
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
96
97 * To list/start/finish release branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
98
04839ae @nvie Forgot list command for hotfixes.
authored
99 git flow release
010252a @nvie Added an optional <base> argument to all start subactions.
authored
100 git flow release start <release> [<base>]
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
101 git flow release finish <release>
78c73dc @nvie Add initial project outline and guidelines.
authored
102
010252a @nvie Added an optional <base> argument to all start subactions.
authored
103 For release branches, the `<base>` arg must be a commit on `develop`.
104
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
105 * To list/start/finish hotfix branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
106
04839ae @nvie Forgot list command for hotfixes.
authored
107 git flow hotfix
010252a @nvie Added an optional <base> argument to all start subactions.
authored
108 git flow hotfix start <release> [<base>]
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
109 git flow hotfix finish <release>
010252a @nvie Added an optional <base> argument to all start subactions.
authored
110
111 For hotfix branches, the `<base>` arg must be a commit on `master`.
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
112
113 * To list/start support branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
114
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
115 git flow support
010252a @nvie Added an optional <base> argument to all start subactions.
authored
116 git flow support start <release> <base>
117
118 For support branches, the `<base>` arg must be a commit on `master`.
78c73dc @nvie Add initial project outline and guidelines.
authored
119
Something went wrong with that request. Please try again.