Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 100 lines (63 sloc) 2.811 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
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
8 > **IMPORTANT NOTE:**
9 > In release 0.2, the order of the arguments has changed to provide a logical
10 > subcommand hierarchy.
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
11
12
12c4ab4 @nvie Update README file to mention new available features.
authored
13 Installing git-flow
14 -------------------
13c9482 @nvie Added instructions to first fetch submodules before installing.
authored
15 After downloading the sources from Github, also fetch the submodules:
16
17 $ git submodule init
18 $ git submodule update
19
20 Then, you can install `git-flow`, using:
78c73dc @nvie Add initial project outline and guidelines.
authored
21
12c4ab4 @nvie Update README file to mention new available features.
authored
22 $ sudo make install
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
23
e0b54c0 @nvie Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
authored
24 By default, git-flow will be installed in /usr/local. To change the prefix
25 where git-flow will be installed, simply specify it explicitly, using:
12c4ab4 @nvie Update README file to mention new available features.
authored
26
e0b54c0 @nvie Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
authored
27 $ sudo make prefix=/opt/local install
dd720be @nvie Dynamically collect the true git exec path and only if that can not b…
authored
28
29 Or simply point your `PATH` environment variable to your git-flow checkout
30 directory.
78c73dc @nvie Add initial project outline and guidelines.
authored
31
32
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
33 Please help out
34 ---------------
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
35 This project is still under development. Feedback and suggestions are very
36 welcome and I encourage you to use the [Issues
37 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
38 feedback.
39
40 Feel free to fork this repo and to commit your additions.
78c73dc @nvie Add initial project outline and guidelines.
authored
41
42
5d1dbe7 @nvie Added (BSD) licensing terms to the project.
authored
43 License terms
44 -------------
45 git-flow is published under the liberal terms of the BSD License, see the
46 [LICENSE](LICENSE) file. Although the BSD License does not require you to share
47 any modifications you make to the source code, you are very much encouraged and
48 invited to contribute back your modifications to the community, preferably
49 in a Github fork, of course.
50
51
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
52 Typical usage:
53 --------------
54
55 ### Initialization
78c73dc @nvie Add initial project outline and guidelines.
authored
56
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
57 To initialize a new repo with the basic branch structure, use:
12c4ab4 @nvie Update README file to mention new available features.
authored
58
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
59 git flow init
f9ebb07 @nvie Added 'git flow init' to the README file.
authored
60
c49c793 @nvie Dotted i's and crossed t's in the README file, for release.
authored
61 This will then interactively prompt you with some questions on which branches
62 you would like to use as development and production branches, and how you
63 would like your prefixes be named. You may simply press Return on any of
64 those questions to accept the (sane) default suggestions.
65
66
67 ### Creating feature/release/hotfix/support branches
12c4ab4 @nvie Update README file to mention new available features.
authored
68
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
69 * To list/start/finish feature branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
70
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
71 git flow feature
72 git flow feature start <name> [<base>]
73 git flow feature finish <name>
78c73dc @nvie Add initial project outline and guidelines.
authored
74
010252a @nvie Added an optional <base> argument to all start subactions.
authored
75 For feature branches, the `<base>` arg must be a commit on `develop`.
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
76
77 * To list/start/finish release branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
78
04839ae @nvie Forgot list command for hotfixes.
authored
79 git flow release
010252a @nvie Added an optional <base> argument to all start subactions.
authored
80 git flow release start <release> [<base>]
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
81 git flow release finish <release>
78c73dc @nvie Add initial project outline and guidelines.
authored
82
010252a @nvie Added an optional <base> argument to all start subactions.
authored
83 For release branches, the `<base>` arg must be a commit on `develop`.
84
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
85 * To list/start/finish hotfix branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
86
04839ae @nvie Forgot list command for hotfixes.
authored
87 git flow hotfix
010252a @nvie Added an optional <base> argument to all start subactions.
authored
88 git flow hotfix start <release> [<base>]
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
89 git flow hotfix finish <release>
010252a @nvie Added an optional <base> argument to all start subactions.
authored
90
91 For hotfix branches, the `<base>` arg must be a commit on `master`.
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
92
93 * To list/start support branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
94
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
95 git flow support
010252a @nvie Added an optional <base> argument to all start subactions.
authored
96 git flow support start <release> <base>
97
98 For support branches, the `<base>` arg must be a commit on `master`.
78c73dc @nvie Add initial project outline and guidelines.
authored
99
Something went wrong with that request. Please try again.