Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 304 lines (267 sloc) 10.254 kb
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
1 #
2 # git-flow -- A collection of Git extensions to provide high-level
3 # repository operations for Vincent Driessen's branching model.
4 #
5 # Original blog post presenting this model is found at:
ddb350b @nvie Change the URL of the original blog post.
nvie authored
6 # http://nvie.com/git-model
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
7 #
8 # Feel free to contribute to this project at:
9 # http://github.com/nvie/gitflow
10 #
d72acba @nvie Added inline license terms to all source files.
nvie authored
11 # Copyright 2010 Vincent Driessen. All rights reserved.
12 #
13 # Redistribution and use in source and binary forms, with or without
14 # modification, are permitted provided that the following conditions are met:
15 #
16 # 1. Redistributions of source code must retain the above copyright notice,
17 # this list of conditions and the following disclaimer.
18 #
19 # 2. Redistributions in binary form must reproduce the above copyright
20 # notice, this list of conditions and the following disclaimer in the
21 # documentation and/or other materials provided with the distribution.
22 #
23 # THIS SOFTWARE IS PROVIDED BY VINCENT DRIESSEN ``AS IS'' AND ANY EXPRESS OR
24 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
26 # EVENT SHALL VINCENT DRIESSEN OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27 # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
30 # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
32 # EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #
34 # The views and conclusions contained in the software and documentation are
35 # those of the authors and should not be interpreted as representing official
36 # policies, either expressed or implied, of Vincent Driessen.
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
37 #
38
39 usage() {
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
40 echo "usage: git flow init [-fd]"
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
41 }
42
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
43 parse_args() {
44 # parse options
45 FLAGS "$@" || exit $?
46 eval set -- "${FLAGS_ARGV}"
47 }
48
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
49 # Default entry when no SUBACTION is given
50 cmd_default() {
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
51 DEFINE_boolean force false 'force setting of gitflow branches, even if already configured' f
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
52 DEFINE_boolean defaults false 'use default branch naming conventions' d
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
53 parse_args "$@"
d2eccaa @josephalevin Issue: 88
josephalevin authored
54
283b0f7 @nvie Fixed a problem with redirection of stdout/stderr. The specifier '2>&1'
nvie authored
55 if ! git rev-parse --git-dir >/dev/null 2>&1; then
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
56 git init
57 else
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
58 # assure that we are not working in a repo with local changes
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
59 git_repo_is_headless || require_clean_working_tree
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
60 fi
61
62 # running git flow init on an already initialized repo is fine
63 if gitflow_is_initialized && ! flag force; then
64 warn "Already initialized for gitflow."
65 warn "To force reinitialization, use: git flow init -f"
66 exit 0
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
67 fi
68
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
69 local branch_count
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
70 local answer
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
71
f78b660 @nvie Move up the notification that default branch names are being used.
nvie authored
72 if flag defaults; then
73 warn "Using default branch names."
74 fi
75
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
76 # add a master branch if no such branch exists yet
77 local master_branch
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
78 if gitflow_has_master_configured && ! flag force; then
79 master_branch=$(git config --get gitflow.branch.master)
80 else
81 # Two cases are distinguished:
82 # 1. A fresh git repo (without any branches)
83 # We will create a new master/develop branch for the user
84 # 2. Some branches do already exist
85 # We will disallow creation of new master/develop branches and
86 # rather allow to use existing branches for git-flow.
87 local default_suggestion
88 local should_check_existence
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
89 branch_count=$(git_local_branches | wc -l)
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
90 if [ "$branch_count" -eq 0 ]; then
91 echo "No branches exist yet. Base branches must be created now."
92 should_check_existence=NO
b1033aa @nvie gitflow-init honors global gitflow configuration that may exist before a
nvie authored
93 default_suggestion=$(git config --get gitflow.branch.master || echo master)
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
94 else
95 echo
96 echo "Which branch should be used for bringing forth production releases?"
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
97 git_local_branches | sed 's/^.*$/ - &/g'
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
98
99 should_check_existence=YES
100 default_suggestion=
b1033aa @nvie gitflow-init honors global gitflow configuration that may exist before a
nvie authored
101 for guess in $(git config --get gitflow.branch.master) \
102 'production' 'main' 'master'; do
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
103 if git_local_branch_exists "$guess"; then
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
104 default_suggestion="$guess"
105 break
106 fi
107 done
108 fi
d2eccaa @josephalevin Issue: 88
josephalevin authored
109
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
110 printf "Branch name for production releases: [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
111 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
112 read answer
113 else
114 printf "\n"
115 fi
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
116 master_branch=${answer:-$default_suggestion}
117
118 # check existence in case of an already existing repo
119 if [ "$should_check_existence" = "YES" ]; then
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
120 git_local_branch_exists "$master_branch" || \
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
121 die "Local branch '$master_branch' does not exist."
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
122 fi
6188206 @nvie Always set the gitflow.branch.master and gitflow.branch.develop prope…
nvie authored
123
124 # store the name of the master branch
125 git config gitflow.branch.master "$master_branch"
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
126 fi
127
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
128 # add a develop branch if no such branch exists yet
129 local develop_branch
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
130 if gitflow_has_develop_configured && ! flag force; then
131 develop_branch=$(git config --get gitflow.branch.develop)
132 else
133 # Again, the same two cases as with the master selection are
134 # considered (fresh repo or repo that contains branches)
135 local default_suggestion
136 local should_check_existence
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
137 branch_count=$(git_local_branches | grep -v "^${master_branch}\$" | wc -l)
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
138 if [ "$branch_count" -eq 0 ]; then
139 should_check_existence=NO
b1033aa @nvie gitflow-init honors global gitflow configuration that may exist before a
nvie authored
140 default_suggestion=$(git config --get gitflow.branch.develop || echo develop)
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
141 else
142 echo
143 echo "Which branch should be used for integration of the \"next release\"?"
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
144 git_local_branches | grep -v "^${master_branch}\$" | sed 's/^.*$/ - &/g'
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
145
146 should_check_existence=YES
147 default_suggestion=
b1033aa @nvie gitflow-init honors global gitflow configuration that may exist before a
nvie authored
148 for guess in $(git config --get gitflow.branch.develop) \
149 'develop' 'int' 'integration' 'master'; do
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
150 if git_local_branch_exists "$guess"; then
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
151 default_suggestion="$guess"
152 break
153 fi
154 done
155 fi
156
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
157 printf "Branch name for \"next release\" development: [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
158 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
159 read answer
160 else
161 printf "\n"
162 fi
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
163 develop_branch=${answer:-$default_suggestion}
164
165 if [ "$master_branch" = "$develop_branch" ]; then
166 die "Production and integration branches should differ."
167 fi
168
169 # check existence in case of an already existing repo
170 if [ "$should_check_existence" = "YES" ]; then
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
171 git_local_branch_exists "$develop_branch" || \
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
172 die "Local branch '$develop_branch' does not exist."
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
173 fi
6188206 @nvie Always set the gitflow.branch.master and gitflow.branch.develop prope…
nvie authored
174
175 # store the name of the develop branch
176 git config gitflow.branch.develop "$develop_branch"
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
177 fi
178
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
179 # Creation of HEAD
180 # ----------------
181 # We create a HEAD now, if it does not exist yet (in a fresh repo). We need
182 # it to be able to create new branches.
3227d80 @nvie Only switch to develop branch if it's newly created.
nvie authored
183 local created_gitflow_branch=0
0161de5 @nvie Added implementation of git-flow-init that asks the user interactivel…
nvie authored
184 if ! git rev-parse --quiet --verify HEAD >/dev/null 2>&1; then
185 git symbolic-ref HEAD "refs/heads/$master_branch"
6188206 @nvie Always set the gitflow.branch.master and gitflow.branch.develop prope…
nvie authored
186 git commit --allow-empty --quiet -m "Initial commit"
3227d80 @nvie Only switch to develop branch if it's newly created.
nvie authored
187 created_gitflow_branch=1
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
188 fi
189
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
190 # Creation of master
191 # ------------------
192 # At this point, there always is a master branch: either it existed already
193 # (and was picked interactively as the production branch) or it has just
194 # been created in a fresh repo
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
195
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
196 # Creation of develop
197 # -------------------
198 # The develop branch possibly does not exist yet. This is the case when,
199 # in a git init'ed repo with one or more commits, master was picked as the
200 # default production branch and develop was "created". We should create
201 # the develop branch now in that case (we base it on master, of course)
7832d6e @nvie Better naming of common functions categorizing them into common,
nvie authored
202 if ! git_local_branch_exists "$develop_branch"; then
3176f74 @nvie Explicitly avoid setting up tracking between develop and master.
nvie authored
203 git branch --no-track "$develop_branch" "$master_branch"
3227d80 @nvie Only switch to develop branch if it's newly created.
nvie authored
204 created_gitflow_branch=1
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
205 fi
206
131c298 @nvie Provided a better way of checking whether master/develop branches need
nvie authored
207 # assert the gitflow repo has been correctly initialized
208 gitflow_is_initialized
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
209
3227d80 @nvie Only switch to develop branch if it's newly created.
nvie authored
210 # switch to develop branch if its newly created
211 if [ $created_gitflow_branch -eq 1 ]; then
212 git checkout -q "$develop_branch"
213 fi
6188206 @nvie Always set the gitflow.branch.master and gitflow.branch.develop prope…
nvie authored
214
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
215 # finally, ask the user for naming conventions (branch and tag prefixes)
b1033aa @nvie gitflow-init honors global gitflow configuration that may exist before a
nvie authored
216 if flag force || \
217 ! git config --get gitflow.prefix.feature >/dev/null 2>&1 ||
218 ! git config --get gitflow.prefix.release >/dev/null 2>&1 ||
219 ! git config --get gitflow.prefix.hotfix >/dev/null 2>&1 ||
220 ! git config --get gitflow.prefix.support >/dev/null 2>&1 ||
221 ! git config --get gitflow.prefix.versiontag >/dev/null 2>&1; then
222 echo
223 echo "How to name your supporting branch prefixes?"
224 fi
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
225
226 local prefix
227
228 # Feature branches
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
229 if ! git config --get gitflow.prefix.feature >/dev/null 2>&1 || flag force; then
230 default_suggestion=$(git config --get gitflow.prefix.feature || echo feature/)
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
231 printf "Feature branches? [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
232 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
233 read answer
234 else
235 printf "\n"
236 fi
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
237 [ "$answer" = "-" ] && prefix= || prefix=${answer:-$default_suggestion}
238 git config gitflow.prefix.feature "$prefix"
239 fi
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
240
241 # Release branches
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
242 if ! git config --get gitflow.prefix.release >/dev/null 2>&1 || flag force; then
243 default_suggestion=$(git config --get gitflow.prefix.release || echo release/)
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
244 printf "Release branches? [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
245 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
246 read answer
247 else
248 printf "\n"
249 fi
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
250 [ "$answer" = "-" ] && prefix= || prefix=${answer:-$default_suggestion}
251 git config gitflow.prefix.release "$prefix"
252 fi
253
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
254
255 # Hotfix branches
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
256 if ! git config --get gitflow.prefix.hotfix >/dev/null 2>&1 || flag force; then
257 default_suggestion=$(git config --get gitflow.prefix.hotfix || echo hotfix/)
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
258 printf "Hotfix branches? [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
259 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
260 read answer
261 else
262 printf "\n"
263 fi
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
264 [ "$answer" = "-" ] && prefix= || prefix=${answer:-$default_suggestion}
265 git config gitflow.prefix.hotfix "$prefix"
266 fi
267
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
268
269 # Support branches
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
270 if ! git config --get gitflow.prefix.support >/dev/null 2>&1 || flag force; then
271 default_suggestion=$(git config --get gitflow.prefix.support || echo support/)
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
272 printf "Support branches? [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
273 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
274 read answer
275 else
276 printf "\n"
277 fi
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
278 [ "$answer" = "-" ] && prefix= || prefix=${answer:-$default_suggestion}
279 git config gitflow.prefix.support "$prefix"
280 fi
281
f476d26 @nvie While we're user input in git flow init, ask the user for all prefix
nvie authored
282
283 # Version tag prefix
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
284 if ! git config --get gitflow.prefix.versiontag >/dev/null 2>&1 || flag force; then
285 default_suggestion=$(git config --get gitflow.prefix.versiontag || echo "")
f6228ed @nvie Replace \c-terminated echo calls by more portable printf calls.
nvie authored
286 printf "Version tag prefix? [$default_suggestion] "
5f860bf @nvie Rewrite Joseph Levin's solution a bit.
nvie authored
287 if noflag defaults; then
d2eccaa @josephalevin Issue: 88
josephalevin authored
288 read answer
289 else
290 printf "\n"
291 fi
1d8bb0d @nvie Add function gitflow_has_prefixes_configured(), to check whether a re…
nvie authored
292 [ "$answer" = "-" ] && prefix= || prefix=${answer:-$default_suggestion}
293 git config gitflow.prefix.versiontag "$prefix"
294 fi
295
6188206 @nvie Always set the gitflow.branch.master and gitflow.branch.develop prope…
nvie authored
296
297 # TODO: what to do with origin?
186d2b5 @nvie Refactored the subcommand invocation logic to form a more hierarchica…
nvie authored
298 }
299
b866b01 @nvie Give all subcommands an optional setup() function that will be called…
nvie authored
300 cmd_help() {
301 usage
302 exit 0
303 }
Something went wrong with that request. Please try again.