mirror of
https://github.com/danielkummer/git-flow-cheatsheet.git
synced 2024-11-22 16:03:26 +01:00
update description
This commit is contained in:
Daniel Kummer
parent
e6ee0aed2a
commit
f787dfd2d0
68
index.html
68
index.html
@ -6,8 +6,8 @@
|
||||
<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">
|
||||
<link rel="stylesheet" href="css/print.css" type="text/css" media="print">
|
||||
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen,print">
|
||||
|
||||
<script src="js/jquery-1.7.2.min.js"></script>
|
||||
|
||||
|
||||
@ -80,28 +80,31 @@
|
||||
|
||||
<div class="scrollblock" style="height: 800px;">
|
||||
<h2>Setup</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>
|
||||
<blockquote>
|
||||
<code>$ brew install git-flow</code>
|
||||
$ brew install git-flow
|
||||
</blockquote>
|
||||
<h3>Linux</h3>
|
||||
<blockquote>
|
||||
<code>$ apt-get install git-flow</code>
|
||||
$ apt-get install git-flow
|
||||
</blockquote>
|
||||
<h3>Windows (Cygwin)</h3>
|
||||
<blockquote>
|
||||
<code>
|
||||
$ wget -q -O - --no-check-certificate
|
||||
https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | bash
|
||||
$ wget -q -O - --no-check-certificate
|
||||
https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | bash
|
||||
</code>
|
||||
</blockquote>
|
||||
</div>
|
||||
<div class="col-2">
|
||||
<p>
|
||||
You need a working git installation as prerequirement.<br/>
|
||||
For detailed instructions please visit the <a href="https://github.com/nvie/gitflow/wiki/Windows">git flow
|
||||
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"/>
|
||||
@ -110,15 +113,14 @@
|
||||
|
||||
<div class="scrollblock">
|
||||
<h2>Getting started</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>
|
||||
<code>
|
||||
git flow init
|
||||
</code>
|
||||
git flow init
|
||||
</blockquote>
|
||||
<p>
|
||||
You'll have to answer a few questions regarding the naming conventions for your branches.<br/>
|
||||
@ -137,21 +139,19 @@
|
||||
|
||||
<div class="scrollblock" style="height: 600px;">
|
||||
<h2>Features</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>
|
||||
<code>
|
||||
git-flow feature start MYFEATURE
|
||||
</code>
|
||||
</blockquote>
|
||||
<p>This action creates a new feature branch based on 'develop' and switches to it</p>
|
||||
|
||||
@ -186,9 +186,7 @@
|
||||
</ul>
|
||||
|
||||
<blockquote>
|
||||
<code>
|
||||
git-flow feature finish MYFEATURE
|
||||
</code>
|
||||
git-flow feature finish MYFEATURE
|
||||
</blockquote>
|
||||
</div>
|
||||
<div class="col-2">
|
||||
@ -206,9 +204,7 @@
|
||||
</p>
|
||||
|
||||
<blockquote>
|
||||
<code>
|
||||
git-flow feature publish MYFEATURE
|
||||
</code>
|
||||
git-flow feature publish MYFEATURE
|
||||
</blockquote>
|
||||
</div>
|
||||
<div class="col-2">
|
||||
@ -225,9 +221,7 @@
|
||||
</p>
|
||||
|
||||
<blockquote>
|
||||
<code>
|
||||
git-flow feature pull MYFEATURE
|
||||
</code>
|
||||
git-flow feature pull MYFEATURE
|
||||
</blockquote>
|
||||
</div>
|
||||
<div class="col-2">
|
||||
@ -243,7 +237,7 @@
|
||||
<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>
|
||||
|
||||
@ -251,9 +245,7 @@
|
||||
creates a release branch created from the 'develop' branch.
|
||||
</p>
|
||||
<blockquote>
|
||||
<code>
|
||||
git flow release start RELEASE [BASE]
|
||||
</code>
|
||||
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
|
||||
@ -276,17 +268,13 @@
|
||||
<li>Removes the release branch</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<code>
|
||||
git flow release finish RELEASE
|
||||
</code>
|
||||
git flow release finish RELEASE
|
||||
</blockquote>
|
||||
|
||||
<p>It's wise to publish a finished release after finishing it. Do it similar to feature publishing with the
|
||||
command:</p>
|
||||
<blockquote>
|
||||
<code>
|
||||
git flow release publish RELEASE
|
||||
</code>
|
||||
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>
|
||||
@ -304,15 +292,13 @@
|
||||
</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>
|
||||
<code>
|
||||
git flow hotfix start RELEASE
|
||||
</code>
|
||||
git flow hotfix start RELEASE
|
||||
</blockquote>
|
||||
<p>The release argument hereby marks the faulty production release</p>
|
||||
</div>
|
||||
@ -343,6 +329,7 @@
|
||||
|
||||
<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
|
||||
@ -350,6 +337,7 @@
|
||||
</li>
|
||||
<li>The 'support' feature is still beta, using it is not advised</li>
|
||||
</ul>
|
||||
<p class="divider">★ ★ ★</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user