GIT Development Workflow

From FirebugWiki

(Difference between revisions)
Jump to: navigation, search
(Added syntax highlighting and fixed little spelling mistake)
Line 7: Line 7:
# After testing your branch by running Firebug test suite on it, merge it into <code>master</code>
# After testing your branch by running Firebug test suite on it, merge it into <code>master</code>
# When doing a release create a tag/branch off of <code>master</code>
# When doing a release create a tag/branch off of <code>master</code>
-
 
=== 1. Master Branch ===
=== 1. Master Branch ===
Line 14: Line 13:
* If you push changes into master they must be tested by Firebug automated test suite and all tests must pass.
* If you push changes into master they must be tested by Firebug automated test suite and all tests must pass.
* You should feel guilty if you break the <code>master</code> branch.
* You should feel guilty if you break the <code>master</code> branch.
-
 
=== 2. Create Feature Branch ===
=== 2. Create Feature Branch ===
Line 20: Line 18:
First clone Firebug repo:
First clone Firebug repo:
-
<pre>
+
<syntaxHighlight lang="bash">
$ git clone git@github.com:firebug/firebug.git
$ git clone git@github.com:firebug/firebug.git
-
</pre>
+
</syntaxHighlight>
Create a new <code>myfeature</code> branch:
Create a new <code>myfeature</code> branch:
-
<pre>
+
<syntaxHighlight lang="bash">
$ cd firebug
$ cd firebug
$ git checkout -b myfeature master
$ git checkout -b myfeature master
-
</pre>
+
</syntaxHighlight>
-
 
+
=== 3. Commit to Feature Branch ===
=== 3. Commit to Feature Branch ===
-
Commit all your changes into your feature branch and publish all the the public server (github.com)
+
Commit all your changes into your feature branch and publish all to the public server ([http://github.com github.com]).
Commit to <code>myfeature</code> branch.
Commit to <code>myfeature</code> branch.
-
<pre>
+
<syntaxHighlight lang="bash">
$ git add <modified-file>
$ git add <modified-file>
$ git commit -m "This is my new feature"
$ git commit -m "This is my new feature"
-
</pre>
+
</syntaxHighlight>
Push to public server into <code>myfeature</code> branch:
Push to public server into <code>myfeature</code> branch:
-
<pre>
+
<syntaxHighlight lang="bash">
$ git push -u origin myfeature
$ git push -u origin myfeature
-
</pre>
+
</syntaxHighlight>
-
 
+
=== 4. Open a Pull Request ===
=== 4. Open a Pull Request ===
Line 50: Line 46:
TODO: some screenshots from github.com explaining how to create a pull request.
TODO: some screenshots from github.com explaining how to create a pull request.
-
 
=== 5. Merge to Master ===
=== 5. Merge to Master ===
Line 57: Line 52:
Switch into <code>myfeature</code> branch:
Switch into <code>myfeature</code> branch:
-
<pre>
+
<syntaxHighlight lang="bash">
$ git checkout myfeature
$ git checkout myfeature
-
</pre>
+
</syntaxHighlight>
Get changes from master. Using rebase here will cause git to pull off the branch commits,
Get changes from master. Using rebase here will cause git to pull off the branch commits,
update the branch to master, then re-apply the commits. Conflicts are easier to fix in this direction
update the branch to master, then re-apply the commits. Conflicts are easier to fix in this direction
than with merge.
than with merge.
-
<pre>
+
<syntaxHighlight lang="bash">
$ git fetch
$ git fetch
$ git rebase master
$ git rebase master
-
</pre>
+
</syntaxHighlight>
Solve any possible conflicts and run Firebug test suite then merge to master.
Solve any possible conflicts and run Firebug test suite then merge to master.
-
<pre>
+
<syntaxHighlight lang="bash">
$ git checkout master
$ git checkout master
$ git merge --no-ff myfeature
$ git merge --no-ff myfeature
-
</pre>
+
</syntaxHighlight>
Don't forget to remove your feature branch after successful merge. It's not needed anymore.
Don't forget to remove your feature branch after successful merge. It's not needed anymore.
-
<pre>
+
<syntaxHighlight lang="bash">
$ git branch -d myfeature
$ git branch -d myfeature
-
</pre>
+
</syntaxHighlight>
Push to public server:
Push to public server:
-
<pre>
+
<syntaxHighlight lang="bash">
$ git push -u origin master
$ git push -u origin master
-
</pre>
+
</syntaxHighlight>
-
 
+
=== 6. Create a Release Branch/Tag ===
=== 6. Create a Release Branch/Tag ===
Line 90: Line 84:
Create minor version tag:
Create minor version tag:
-
<pre>
+
<syntaxHighlight lang="bash">
$ ./bump-version.sh 1.10.0a5
$ ./bump-version.sh 1.10.0a5
$ git commit -a -m "[firebug-1.10.0a5]"
$ git commit -a -m "[firebug-1.10.0a5]"
$ git tag 1.10.0a5
$ git tag 1.10.0a5
$ git push --tags
$ git push --tags
-
</pre>
+
</syntaxHighlight>
Create major version branch:
Create major version branch:
-
<pre>
+
<syntaxHighlight lang="bash">
$ git checkout branch firebug-1.10.0a5
$ git checkout branch firebug-1.10.0a5
-
</pre>
+
</syntaxHighlight>
Push to public server:
Push to public server:
-
<pre>
+
<syntaxHighlight lang="bash">
$ git push -u origin master
$ git push -u origin master
-
</pre>
+
</syntaxHighlight>
-
 
+
TODO: process for hot fixes in existing release branches
TODO: process for hot fixes in existing release branches
Line 116: Line 109:
* Windows:
* Windows:
-
<pre>
+
<syntaxHighlight lang="bash">
   git config --global core.autocrlf true
   git config --global core.autocrlf true
   git config --global core.safecrlf false
   git config --global core.safecrlf false
-
</pre>
+
</syntaxHighlight>
-
Linux:
+
* Linux:
-
<pre>
+
<syntaxHighlight lang="bash">
   git config --global core.autocrlf input
   git config --global core.autocrlf input
   git config --global core.safecrlf false
   git config --global core.safecrlf false
-
</pre>
+
</syntaxHighlight>
It's also useful to have following aliases defined in your ''.gitconfig''
It's also useful to have following aliases defined in your ''.gitconfig''
-
<pre>
+
<syntaxHighlight lang="ini">
[alias]
[alias]
   co = checkout
   co = checkout
Line 136: Line 129:
   br = branch
   br = branch
   hist = log --pretty=format:\"%h %ad | %s%d [%an]\" --graph --date=short
   hist = log --pretty=format:\"%h %ad | %s%d [%an]\" --graph --date=short
-
</pre>
+
</syntaxHighlight>

Revision as of 14:59, 10 March 2012

Contents

General Workflow

  1. Anything in the master branch is deployable
  2. To implement a new features or bug fix, create a new feature branch off of master
  3. Commit all your changes to the branch and push on the server
  4. When you need feedback/review/help open a pull request
  5. After testing your branch by running Firebug test suite on it, merge it into master
  6. When doing a release create a tag/branch off of master

1. Master Branch

  • The master branch should be stable.
  • It should be always safe to make a release from it.
  • If you push changes into master they must be tested by Firebug automated test suite and all tests must pass.
  • You should feel guilty if you break the master branch.

2. Create Feature Branch

When you work on a new feature (or fixing a bug), create a new feature branch.

First clone Firebug repo:

$ git clone git@github.com:firebug/firebug.git

Create a new myfeature branch:

$ cd firebug
$ git checkout -b myfeature master

3. Commit to Feature Branch

Commit all your changes into your feature branch and publish all to the public server (github.com).

Commit to myfeature branch.

$ git add <modified-file>
$ git commit -m "This is my new feature"

Push to public server into myfeature branch:

$ git push -u origin myfeature

4. Open a Pull Request

If you need somebody from the team to review your code open a pull request.

TODO: some screenshots from github.com explaining how to create a pull request.

5. Merge to Master

After you are done with your changes you can merge your branch back to master. Since master could have changed in the meantime you should update your branch before merge and solve any possible conflicts.

Switch into myfeature branch:

$ git checkout myfeature

Get changes from master. Using rebase here will cause git to pull off the branch commits, update the branch to master, then re-apply the commits. Conflicts are easier to fix in this direction than with merge.

$ git fetch
$ git rebase master

Solve any possible conflicts and run Firebug test suite then merge to master.

$ git checkout master
$ git merge --no-ff myfeature

Don't forget to remove your feature branch after successful merge. It's not needed anymore.

$ git branch -d myfeature

Push to public server:

$ git push -u origin master

6. Create a Release Branch/Tag

When doing a minor (alpha or beta) release create a tag at appropriate revision that bumps up the version number. In case of a major (final) release create a branch (e.g. firebug1.10)

Create minor version tag:

$ ./bump-version.sh 1.10.0a5
$ git commit -a -m "[firebug-1.10.0a5]"
$ git tag 1.10.0a5
$ git push --tags

Create major version branch:

$ git checkout branch firebug-1.10.0a5

Push to public server:

$ git push -u origin master

TODO: process for hot fixes in existing release branches

Recommended Settings

Recommended settings in your .gitconfig file:

Entire Firebug repository should use Unix line endings.

  • Windows:
   git config --global core.autocrlf true
   git config --global core.safecrlf false
  • Linux:
   git config --global core.autocrlf input
   git config --global core.safecrlf false

It's also useful to have following aliases defined in your .gitconfig

[alias]
  co = checkout
  ci = commit
  st = status
  br = branch
  hist = log --pretty=format:\"%h %ad | %s%d [%an]\" --graph --date=short
Personal tools