Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 80 lines (52 sloc) 2.262 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
78c73dc @nvie Add initial project outline and guidelines.
authored
4 for Vincent Driessen's [branching model](http://nvie.com/archives/323 "original
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 -------------------
15 To install `git-flow` as a real `git` subcommand, run:
78c73dc @nvie Add initial project outline and guidelines.
authored
16
12c4ab4 @nvie Update README file to mention new available features.
authored
17 $ sudo make install
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
18
dd720be @nvie Dynamically collect the true git exec path and only if that can not b…
authored
19 By default, this will look for the directory where Git is already installed,
20 and install the git-flow extension alongside the other Git subcommands. If git
21 is not on the system's `PATH`, it tries `/usr/libexec/git-core`. To explicitly
22 override this setting in case you have installed Git in another location, use:
12c4ab4 @nvie Update README file to mention new available features.
authored
23
dd720be @nvie Dynamically collect the true git exec path and only if that can not b…
authored
24 $ sudo make GIT_EXEC_PATH=/your/custom/path install
12c4ab4 @nvie Update README file to mention new available features.
authored
25
dd720be @nvie Dynamically collect the true git exec path and only if that can not b…
authored
26 You rarely need to override this manually, the default 'make install' should do
27 fine.
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 ---------------
35 This project is still under development. What is available today is merely its
36 foundation. However, it is functional in its current form and should be usable
37 under normal use. (Don't try to create multiple release branches next to each
38 other and stuff like that, yet.)
39
40 Feedback and suggestions are very welcome and I encourage you to use the
41 [Issues list](http://github.com/nvie/gitflow/issues) on Github to provide that
42 feedback.
43
44 Feel free to fork this repo and to commit your additions.
78c73dc @nvie Add initial project outline and guidelines.
authored
45
46
f206ba6 @nvie Update README file to match the 0.1 release status.
authored
47 Example uses:
48 -------------
78c73dc @nvie Add initial project outline and guidelines.
authored
49
12c4ab4 @nvie Update README file to mention new available features.
authored
50 * To initialize a new repo with the basic branch structure, instead of using
51 `git init`, use:
52
53 git flow init
54
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
55 * To list/start/finish feature branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
56
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
57 git flow feature
58 git flow feature start <name> [<base>]
59 git flow feature finish <name>
78c73dc @nvie Add initial project outline and guidelines.
authored
60
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
61 (`base` is `develop` by default)
62
63 * To list/start/finish release branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
64
04839ae @nvie Forgot list command for hotfixes.
authored
65 git flow release
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
66 git flow release start <release>
67 git flow release finish <release>
78c73dc @nvie Add initial project outline and guidelines.
authored
68
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
69 * To list/start/finish hotfix branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
70
04839ae @nvie Forgot list command for hotfixes.
authored
71 git flow hotfix
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
72 git flow hotfix start <release> [<base-release>]
73 git flow hotfix finish <release>
74
75 * To list/start support branches, use:
78c73dc @nvie Add initial project outline and guidelines.
authored
76
c81e7a2 @nvie Update the README to reflect the new subcommand structure.
authored
77 git flow support
78 git flow support start <release> [<base-release>]
78c73dc @nvie Add initial project outline and guidelines.
authored
79
Something went wrong with that request. Please try again.