forked from danielkummer/git-flow-cheatsheet
/
index.html
404 lines (342 loc) · 13.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>git-flow cheatsheet</title>
<link href='http://fonts.googleapis.com/css?family=Sansita+One' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="css/normalize.css" type="text/css" media="screen,print">
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen,print">
<script src="js/jquery-1.7.2.min.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33766650-1']);
_gaq.push(['_trackPageview']);
(function () {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="banner"><a href="https://github.com/danielkummer/git-flow-cheatsheet">Fork me on GitHub</a></div>
<header>
<h1 id="title">git-flow cheatsheet</h1>
<p id="author">
created by <a href="http://twitter.com/0r1g4m14dd1c7">Daniel Kummer</a>
<a href="https://twitter.com/share" class="twitter-share-button" data-via="0r1g4m14dd1c7" data-size="large">Tweet</a>
<script>!function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (!d.getElementById(id)) {
js = d.createElement(s);
js.id = id;
js.src = "//platform.twitter.com/widgets.js";
fjs.parentNode.insertBefore(js, fjs);
}
}(document, "script", "twitter-wjs");</script>
</p>
<p id="desc">efficient branching using git-flow by <a href="http://nvie.com/">Vincent Driessen</a></p>
<p id="translations">translations:
<a href="#" class="active" title="english">English</a> -
<a href="index.es_ES.html" title="spanish">Castellano</a> -
<a href="index.pt_BR.html" title="Brazilian Portugues">Brazilian Portugues</a> -
<a href="index.zh_TW.html" title="Traditional Chinese">繁體中文(Traditional Chinese)</a> -
<a href="index.zh_CN.html" title="Simplified Chinese">简体中文(Simplified Chinese)</a> -
<a href="index.ja_JP.html" title="日本語">日本語</a> -
<a href="index.tr_TR.html" title="Turkce">Türkçe</a> -
<a href="index.ko_KR.html" title="한국어">한국어(Korean)</a> -
<a href="index.fr_FR.html" title="Français">Français</a> -
<a href="index.it_IT.html" title="Italiano">Italiano</a> -
<a href="index.nl_NL.html" title="Nederlands">Nederlands</a> -
<a href="index.ru_RU.html" title="Russian">Русский (Russian)</a> -
<a href="index.de_DE.html" title="German">Deutsch (German)</a> -
<a href="index.ca_CA.html" title="Català">Català (Catalan)</a>
</p>
</header>
<div id="main">
<div class="scrollblock">
<h2>About</h2>
<p>
git-flow are a set of git extensions to provide high-level repository operations for Vincent
Driessen's branching model.
<small><a href="http://nvie.com/posts/a-successful-git-branching-model/">more</a></small>
</p>
<p class="divider">★ ★ ★</p>
<p>This cheatsheet shows the basic usage and effect of git-flow operations</p>
<p class="divider">★ ★ ★</p>
</div>
<div class="scrollblock">
<h2>Basic tips</h2>
<ul>
<li>Git flow provides excellent command line help and output. Read it carefully to see what's happening...</li>
<li>The OSX/Windows Client <a href="http://www.sourcetreeapp.com/">Sourcetree</a> is an excellent git gui and provides
git-flow support
</li>
<li>Git-flow is a merge based solution. It doesn't rebase feature branches.</li>
</ul>
<p class="divider">★ ★ ★</p>
</div>
<div class="scrollblock">
<h2><a name="setup" href="#setup">Setup</a></h2>
<ul>
<li>You need a working git installation as prerequisite.</li>
<li>Git flow works on OSX, Linux and Windows</li>
</ul>
<p class="divider">★ ★ ★</p>
<div class="col-1">
<h3>OSX</h3>
<span>Homebrew</span>
<blockquote>
$ brew install git-flow
</blockquote>
<span>Macports</span>
<blockquote>
$ port install git-flow
</blockquote>
<h3>Linux</h3>
<blockquote>
$ apt-get install git-flow
</blockquote>
<h3>Windows (Cygwin)</h3>
<blockquote>
$ wget -q -O - --no-check-certificate
https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | bash
</blockquote>
<p>You need wget and util-linux to install git-flow.</p>
</div>
<div class="col-2">
<p>
For detailed git flow intallation instructions please visit the <a href="https://github.com/nvie/gitflow/wiki/Windows">git flow
wiki</a>.
</p>
<img src="img/download.png" alt="install git-flow"/>
</div>
</div>
<div class="scrollblock">
<h2><a name="getting_started" href="#getting_started">Getting started</a></h2>
<p>Git flow needs to be initialized in order to customize your project setup.</p>
<p class="divider">★ ★ ★</p>
<div class="col-1">
<h3>Initialize</h3>
<p>Start using git-flow by initializing it inside an existing git repository:</p>
<blockquote>
git flow init
</blockquote>
<p>
You'll have to answer a few questions regarding the naming conventions for your branches.<br/>
It's recommended to use the default values.
</p>
</div>
<div class="col-2">
<div class="initialize"></div>
<div class="lines-small"></div>
<div class="lines-open"></div>
<div class="lines-big"></div>
</div>
</div>
<div class="scrollblock">
<h2><a name="features" href="#features">Features</a></h2>
<ul class="narrow">
<li>Develop new features for upcoming releases</li>
<li>Typically exist in developers repos only</li>
</ul>
<p class="divider">★ ★ ★</p>
<div class="col-1">
<h3>Start a new feature</h3>
<p>Development of new features starting from the 'develop' branch.</p>
<p>Start developing a new feature with</p>
<blockquote>
git flow feature start MYFEATURE
</blockquote>
<p>This action creates a new feature branch based on 'develop' and switches to it</p>
<!--
- Bump the version number now!
- Start committing last-minute fixes in preparing your release
- When done, run:
git flow release finish 'testrelease'
-->
</div>
<div class="col-2">
<div class="feature-start"></div>
</div>
</div>
<div class="scrollblock">
<div class="col-1">
<h3>Finish up a feature</h3>
<p>
Finish the development of a feature.
This action performs the following
</p>
<ul>
<li>Merged MYFEATURE into 'develop'</li>
<li>Removes the feature branch</li>
<li>Switches back to 'develop' branch</li>
</ul>
<blockquote>
git flow feature finish MYFEATURE
</blockquote>
</div>
<div class="col-2">
<div class="feature-end"></div>
</div>
</div>
<div class="scrollblock">
<div class="col-1">
<h3>Publish a feature</h3>
<p>
Are you developing a feature in collaboration? <br/>
Publish a feature to the remote server so it can be used by other users.
</p>
<blockquote>
git flow feature publish MYFEATURE
</blockquote>
</div>
<div class="col-2">
<div class="feature-publish"></div>
</div>
</div>
<div class="scrollblock">
<div class="col-1">
<h3>Getting a published feature</h3>
<p>
Get a feature published by another user.
</p>
<blockquote>
git flow feature pull origin MYFEATURE
</blockquote>
<p>You can track a feature on origin by using <code> git flow feature track MYFEATURE</code> </p>
</div>
<div class="col-2">
<div class="feature-pull"></div>
</div>
</div>
<div class="scrollblock">
<h2><a name="release" href="#release">Make a release</a></h2>
<ul>
<li>Support preparation of a new production release</li>
<li>Allow for minor bug fixes and preparing meta-data for a release</li>
</ul>
<p class="divider">★ ★ ★</p>
<div class="col-1">
<h3>Start a release</h3>
<p>To start a release, use the git flow release command. It creates a release branch created from the 'develop' branch.</p>
<blockquote>
git flow release start RELEASE [BASE]
</blockquote>
<p>You can optionally supply a <code>[BASE]</code> commit sha-1 hash to start the release from. The commit must
be on the
'develop' branch.</p>
<p class="divider">★ ★ ★</p>
<p>It's wise to publish the release branch after creating it to allow release commits by other developers. Do it similar to feature publishing with the command:</p>
<blockquote>
git flow release publish RELEASE
</blockquote>
<p>(You can track a remote release with the <br/><code>git flow release track RELEASE</code> command)</p>
</div>
<div class="col-2">
<div class="release-start"></div>
</div>
</div>
<div class="scrollblock">
<div class="col-1">
<h3>Finish up a release</h3>
<p>Finishing a release is one of the big steps in git branching. It performs several actions:</p>
<ul>
<li>Merges the release branch back into 'master'</li>
<li>Tags the release with its name</li>
<li>Back-merges the release into 'develop'</li>
<li>Removes the release branch</li>
</ul>
<blockquote>
git flow release finish RELEASE
</blockquote>
<p>Don't forget to push your tags with<code>git push --tags</code></p>
</div>
<div class="col-2">
<div class="release-end"></div>
</div>
</div>
<div class="scrollblock">
<h2><a name="hotfixes" href="#hotfixes">Hotfixes</a></h2>
<ul>
<li>Hotfixes arise from the necessity to act immediately upon an undesired state of a live production version
</li>
<li>May be branched off from the corresponding tag on the master branch that marks the production version.</li>
</ul>
<p class="divider">★ ★ ★</p>
<div class="col-1">
<h3>git flow hotfix start</h3>
<p>Like the other git flow commands, a hotfix is started with</p>
<blockquote>
git flow hotfix start VERSION [BASENAME]
</blockquote>
<p>The version argument hereby marks the new hotfix release name. Optionally you can specify a basename to start from.</p>
</div>
<div class="col-2">
<div class="hotfix-start"></div>
</div>
</div>
<div class="scrollblock">
<div class="col-1">
<h3>Finish a hotfix</h3>
<p>By finishing a hotfix it gets merged back into develop and master. Additionally the master merge is tagged with the hotfix version.</p>
<blockquote>
git flow hotfix finish VERSION
</blockquote>
</div>
<div class="col-2">
<div class="hotfix-end"></div>
</div>
</div>
<div>
<div class="col-1"></div>
<div class="col-2">
<div class="lines-close"></div>
<div class="lines-small-end"></div>
</div>
</div>
<div class="scrollblock">
<h2><a name="commands" href="#commands">Commands</a></h2>
<img src="img/git-flow-commands.png" alt="git-flow commands"/>
</div>
<div class="scrollblock">
<h2>Backlog</h2>
<p class="divider">★ ★ ★</p>
<ul>
<li>Not all available commands are covered here, only the most important ones</li>
<li>You can still use git and all its commands normally as you know them, git flow is only a tooling
collection
</li>
<li>The 'support' feature is still beta, using it is not advised</li>
<li>If you'd like to supply translations I'd be happy to integrate them</li>
</ul>
<p class="divider">★ ★ ★</p>
</div>
</div>
<footer>
<div class="scrollblock">
<h2><a name="comments" href="#comments">Comments</a></h2>
<div id="disqus_thread"></div>
</div>
</footer>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'gitflowcheatsheet'; // required: replace example with your forum shortname
/* * * DON'T EDIT BELOW THIS LINE * * */
(function () {
var dsq = document.createElement('script');
dsq.type = 'text/javascript';
dsq.async = true;
dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a>
</noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
</body>
</html>