Skip to content
This repository
Newer
Older
100644 101 lines (64 sloc) 2.883 kb
6c2d30bb »
2010-01-26 Structurally replace gitflow by git-flow, as a true git extension.
1 git-flow
2 ========
12c4ab4f »
2010-01-26 Update README file to mention new available features.
3 A collection of Git extensions to provide high-level repository operations
4fc0bc16 »
2010-02-24 Use a more friendly URL for the original blog post URL.
4 for Vincent Driessen's [branching model](http://nvie.com/git-model "original
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
5 blog post").
6
7
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
8 > **IMPORTANT NOTE:**
9 > In release 0.2, the order of the arguments has changed to provide a logical
10 > subcommand hierarchy.
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
11
12
12c4ab4f »
2010-01-26 Update README file to mention new available features.
13 Installing git-flow
14 -------------------
13c94821 »
2010-02-15 Added instructions to first fetch submodules before installing.
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:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
21
12c4ab4f »
2010-01-26 Update README file to mention new available features.
22 $ sudo make install
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
23
e0b54c07 »
2010-03-19 Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
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:
12c4ab4f »
2010-01-26 Update README file to mention new available features.
26
e0b54c07 »
2010-03-19 Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
27 $ sudo make prefix=/opt/local install
dd720bea »
2010-01-27 Dynamically collect the true git exec path and only if that can not b…
28
29 Or simply point your `PATH` environment variable to your git-flow checkout
30 directory.
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
31
32
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
33 Please help out
34 ---------------
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
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
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
38 feedback.
39
d79a0d45 »
2010-04-04 Added referral link to the AUTHORS file.
40 Feel free to fork this repo and to commit your additions. For a list of all
41 contributors, please see the [AUTHORS](AUTHORS) file.
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
42
43
5d1dbe74 »
2010-04-04 Added (BSD) licensing terms to the project.
44 License terms
45 -------------
46 git-flow is published under the liberal terms of the BSD License, see the
47 [LICENSE](LICENSE) file. Although the BSD License does not require you to share
48 any modifications you make to the source code, you are very much encouraged and
49 invited to contribute back your modifications to the community, preferably
50 in a Github fork, of course.
51
52
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
53 Typical usage:
54 --------------
55
56 ### Initialization
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
57
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
58 To initialize a new repo with the basic branch structure, use:
12c4ab4f »
2010-01-26 Update README file to mention new available features.
59
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
60 git flow init
f9ebb076 »
2010-02-22 Added 'git flow init' to the README file.
61
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
62 This will then interactively prompt you with some questions on which branches
63 you would like to use as development and production branches, and how you
64 would like your prefixes be named. You may simply press Return on any of
65 those questions to accept the (sane) default suggestions.
66
67
68 ### Creating feature/release/hotfix/support branches
12c4ab4f »
2010-01-26 Update README file to mention new available features.
69
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
70 * To list/start/finish feature branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
71
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
72 git flow feature
73 git flow feature start <name> [<base>]
74 git flow feature finish <name>
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
75
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
76 For feature branches, the `<base>` arg must be a commit on `develop`.
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
77
78 * To list/start/finish release branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
79
04839aef »
2010-01-28 Forgot list command for hotfixes.
80 git flow release
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
81 git flow release start <release> [<base>]
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
82 git flow release finish <release>
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
83
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
84 For release branches, the `<base>` arg must be a commit on `develop`.
85
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
86 * To list/start/finish hotfix branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
87
04839aef »
2010-01-28 Forgot list command for hotfixes.
88 git flow hotfix
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
89 git flow hotfix start <release> [<base>]
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
90 git flow hotfix finish <release>
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
91
92 For hotfix branches, the `<base>` arg must be a commit on `master`.
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
93
94 * To list/start support branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
95
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
96 git flow support
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
97 git flow support start <release> <base>
98
99 For support branches, the `<base>` arg must be a commit on `master`.
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
100
Something went wrong with that request. Please try again.