Difference between revisions of "Development/Git/Feature Branch Workflow"

Jump to: navigation, search
(Simple Feature Branch Workflow)
(Remote Feature Development)
 
(17 intermediate revisions by one user not shown)
Line 5: Line 5:
 
This Git Workflow is the recommended KDE Git Workflow for smaller projects where  new features are developed in local and/or remote feature branches before being reviewed and merged back into the master branch.
 
This Git Workflow is the recommended KDE Git Workflow for smaller projects where  new features are developed in local and/or remote feature branches before being reviewed and merged back into the master branch.
  
This workflow is designed to be used after initial use of the [[Development/Git/Simple_Workflow|Simple Workflow]].  It is assumed you have read and mastered the basic concepts as outlined in that Workflow, such as staged and unstaged changes.
+
This workflow is designed to be used after initial use of the [[Development/Git/Simple_Workflow|Simple Workflow]].  It is assumed you have read and mastered the basic concepts as outlined in that Workflow, such as unstaged and staged changes, committing, rebasing and pushing.
  
 
Note that each module may choose to adopt a more complex workflow, in particular the Integration Branch Workflow, and you should check with your modules maintainers if this is the case.
 
Note that each module may choose to adopt a more complex workflow, in particular the Integration Branch Workflow, and you should check with your modules maintainers if this is the case.
Line 13: Line 13:
 
== Set-up ==
 
== Set-up ==
  
See the [[Development/Git/Simple_Workflow#Set-up|Simple Workflow Set-up]] section for instructions on configuring Git and Cloning you Repository
+
See the [[Development/Git/Simple_Workflow#Set-up|Simple Workflow Set-up]] section for instructions on configuring Git and Cloning your Repository
  
 
== Local Feature Development ==
 
== Local Feature Development ==
  
 +
By default when you first create a repository clone there is only a single local branch called 'master'.  It is not good practice to do development in master, it is better kept clean for reference.  Instead all work should be performed in a new local branch, even bug fixes.
  
=== Create a Work Branch ===
+
=== Create a Local Work Branch ===
 
+
By default when you first create a repository clone there is only a single local branch called 'master'.  It is not good practice to do development in master, it is better kept clean for reference.  Instead all work should be performed in a new local branch, even bug fixes.
+
  
 
To see what local branches you have:
 
To see what local branches you have:
  
 
  git branch
 
  git branch
 +
 +
This will initially appear as follows, with the * indicating your current working branch:
 +
 +
* master
  
 
To see all local and remote branches:
 
To see all local and remote branches:
  
 
  git branch -a
 
  git branch -a
 +
 +
This will initially look something like:
 +
 +
*  master
 +
    remotes/origin/HEAD -> origin/master
 +
    remotes/origin/KDE/4.5
 +
    remotes/origin/KDE/4.6
 +
    remotes/origin/kdecore/klocale-win
 +
    remotes/origin/kdeui/kdatetimeedit
  
 
To create a new local branch:
 
To create a new local branch:
  
 
  git branch <new-branch>
 
  git branch <new-branch>
 +
 +
Now running <tt>git branch</tt> will show:
 +
 +
*  master
 +
    my-new-branch
  
 
To change to the new branch to work on it:
 
To change to the new branch to work on it:
Line 38: Line 55:
 
  git checkout <new-branch>
 
  git checkout <new-branch>
  
This will create a new branch based on whatever local branch you were already in, i.e. that includes all the history of the original branch, which can be useful in building a hierarchy of dependent changes.
+
Now running <tt>git branch</tt> will show:
  
You may prefer to base your new branch on a remote branch such as the master branch of the central repository so you can integrate any new development.  This is called 'tracking' and is recommended for most branches:
+
    master
 +
*  my-new-branch
 +
 
 +
This sequence will create a new branch based on whatever local branch you were already in, i.e. that includes all the history of the original branch, which can be useful in building a hierarchy of dependent changes.
 +
 
 +
You may prefer to base your new branch on a remote branch such as the master branch of the central repository so you can integrate any new development.  This is called 'tracking' a remote branch and is recommended for most work branches:
  
 
  git branch --track <local-branch> <remote-branch>
 
  git branch --track <local-branch> <remote-branch>
  
For example to develop a new feature called 'bar' based on the master branch:
+
For example to develop a new feature called 'bar' based on the central repository master branch:
  
 
  git branch --track new-bar-feature origin/master
 
  git branch --track new-bar-feature origin/master
  
=== Commit Your Changes ===
+
=== Making Changes ===
  
=== Push Your Changes ===
+
You can now make [[Development/Git/Simple_Workflow#Making_Local_Changes_and_Commits|local changes and commits]], and [[Development/Git/Simple_Workflow#Pushing_Your_Changes_To_The_Central_Repository|push them to the central repository]] exactly as described in the [[Development/Git/Simple_Workflow|Simple Workflow]].
  
== Local Feature Development ==
+
Your project may require changes to be reviewed before pushing to the central code repository.  All projects on git.kde.org automatically have a [[Development/Review_Board|Review Board]] group created for them which you can use for this purpose.  It is recommended that you use the [[Development/Review_Board#Using_post-review_to_post_changes_for_review|post-review script]] to automatically generate and upload the diff of your changes.
 +
 
 +
=== Deleting Local Branches ===
 +
 
 +
Once you have finished with a local feature branch and pushed all your commits to the central repository you can delete the local branch if you no longer require it.
 +
 
 +
First, you have to change to a different branch:
 +
 
 +
git checkout master
  
This example workflow is for locally working on new features in unstable branch and pushing them to the central repository.
+
Then you can delete the feature branch:
  
This workflow is only recommended for small features or where you are the only developer on a project.
+
git -d <local-branch>
  
 
== Remote Feature Development ==
 
== Remote Feature Development ==
  
This example workflow is for working on new features in a feature branch hosted on the central repository.
+
This example workflow is for working on new features in a feature branch hosted on the central repository.  This workflow is recommended for larger features or where there are many developers on a project.
  
This workflow is recommended for larger features or where there are many developers on a project.
+
The main disadvantage of local feature branch development is no-one else can see your code changes or help you until the finished feature is pushed to master on the central repository.  You could resolve this by regularly pushing incomplete features to master, but this will lead to master becoming more unstable.  The proper solution is to create a Remote Feature Branch on the central repository where you can push your interim work for others to see and also push changes to.
 +
 
 +
TODO: Finish this.
 +
 
 +
TODO Steps:
 +
* Create the remote branch tracking master
 +
  git push origin master:refs/heads/<remote-branch>
 +
  git fetch origin
 +
* Create your local branch tracking the remote branch
 +
  git branch --track <local-branch> origin/<remote-branch>
 +
  git checkout <local-branch>
 +
* Do local dev and commits, rebase, push
 +
* When to use Merges, when to Rebase?
 +
* Once local commits are pushed you cannot rewrite them!
  
 
== Local Bug Fixing ==
 
== Local Bug Fixing ==
Line 68: Line 111:
 
This example workflow is for locally fixing bugs in both the stable and unstable branches and pushing them to the central repository.
 
This example workflow is for locally fixing bugs in both the stable and unstable branches and pushing them to the central repository.
  
In Git, stable branches are just regular branches that have special meaning to a project and a possibly a special naming scheme to distinguish them.  For example, kdelibs includes the following branches on the central repository:
+
In Git, stable branches are just regular branches that have special meaning to a project and possibly a special naming scheme to distinguish them.  For example, kdelibs includes the following branches on the central repository:
  
 
   origin/HEAD -> origin/master
 
   origin/HEAD -> origin/master
Line 81: Line 124:
 
Making bug fixes to stable branches is thus fundamentally the same as working on a feature branch, but with the added step of needing to push the bug fix to both the stable and unstable branch in the central repository.
 
Making bug fixes to stable branches is thus fundamentally the same as working on a feature branch, but with the added step of needing to push the bug fix to both the stable and unstable branch in the central repository.
  
Two workflow's are described here, a basic workflow for small apps or where bug-fixes are infrequent, and an advanced workflow for larger apps or more frequent bug-fixes.
+
In the [[Development/Git/Simple_Workflow#Local_Bug_Fixing|Simple Workflow bug fixing]] section we describe a simple way to perform bug fixes for both stable and unstable branches in the same repository clone.
 
+
=== Basic Bug Fix Workflow ===
+
 
+
To make bug fixes on the 2.0 release you could simply checkout a local copy of the origin/release/2.0 branch and make you bug fixes there:
+
  
git branch --track bug-fix-2.0 origin/release/2.0
+
The basic workflow works fine except switching between unstable and stable branches inside a single Git repository can lead to large rebuilds if the unstable branch has diverged too much from the stable branch.  On a small app this overhead may be small enough to not be a problem, but in most cases this constant rebuilding will be a waste of time.
  git checkout bug-fix-2.0
+
<make changes, build, test>
+
git commit -a
+
git push origin bug-fix-2.0:release/2.0
+
git branch --track bug-fix-master origin/master
+
git checkout bug-fix-master
+
git cherry-pick -x -e <sha5 of stable commit>
+
<build, test>
+
git push origin bug-fix-master:master
+
  
=== Advanced Bug Fix Workflow ===
+
One alternative is to have two separate clones using two separate build environments, but this wastes disk space and causes problems with keeping the separate clones in sync.
  
the basic workflow works fine except switching between unstable and stable branches inside a single Git repository can lead to large rebuilds if the unstable branch has diverged too much from the stable branch. On a small app this overhead may be small enough to not be a problem, but in most cases this constant rebuilding will be a waste of time.
+
A better alternative is to use the [[Development/Git/Configuration#Multiple_Work_Branches|git-new-workdir script]] to create separate work directories and builds for the stable and unstable branches using the same repository clone. This depends on you setting different up KDE Environments for the separate builds.
  
This workflow uses the [[http://techbase.kde.org/Development/Git/Configuration#Multiple_Work_Branches|git-new-workdir script]] to create separate work directories and builds for stable and unstable branches. This depends on you setting different up KDE Environments for the separate builds.
+
TODO: Finish this.

Latest revision as of 18:26, 13 June 2011

THIS IS A DRAFT, DO NOT USE!

Contents

[edit] Feature Branch Workflow

This Git Workflow is the recommended KDE Git Workflow for smaller projects where new features are developed in local and/or remote feature branches before being reviewed and merged back into the master branch.

This workflow is designed to be used after initial use of the Simple Workflow. It is assumed you have read and mastered the basic concepts as outlined in that Workflow, such as unstaged and staged changes, committing, rebasing and pushing.

Note that each module may choose to adopt a more complex workflow, in particular the Integration Branch Workflow, and you should check with your modules maintainers if this is the case.

More detailed information can be found on the main KDE Git page. More details on the various commands can be found on the KDE Git Recipes page.

[edit] Set-up

See the Simple Workflow Set-up section for instructions on configuring Git and Cloning your Repository

[edit] Local Feature Development

By default when you first create a repository clone there is only a single local branch called 'master'. It is not good practice to do development in master, it is better kept clean for reference. Instead all work should be performed in a new local branch, even bug fixes.

[edit] Create a Local Work Branch

To see what local branches you have:

git branch

This will initially appear as follows, with the * indicating your current working branch:

* master

To see all local and remote branches:

git branch -a

This will initially look something like:

*  master
   remotes/origin/HEAD -> origin/master
   remotes/origin/KDE/4.5
   remotes/origin/KDE/4.6
   remotes/origin/kdecore/klocale-win
   remotes/origin/kdeui/kdatetimeedit

To create a new local branch:

git branch <new-branch>

Now running git branch will show:

*  master
   my-new-branch

To change to the new branch to work on it:

git checkout <new-branch>

Now running git branch will show:

   master
*  my-new-branch

This sequence will create a new branch based on whatever local branch you were already in, i.e. that includes all the history of the original branch, which can be useful in building a hierarchy of dependent changes.

You may prefer to base your new branch on a remote branch such as the master branch of the central repository so you can integrate any new development. This is called 'tracking' a remote branch and is recommended for most work branches:

git branch --track <local-branch> <remote-branch>

For example to develop a new feature called 'bar' based on the central repository master branch:

git branch --track new-bar-feature origin/master

[edit] Making Changes

You can now make local changes and commits, and push them to the central repository exactly as described in the Simple Workflow.

Your project may require changes to be reviewed before pushing to the central code repository. All projects on git.kde.org automatically have a Review Board group created for them which you can use for this purpose. It is recommended that you use the post-review script to automatically generate and upload the diff of your changes.

[edit] Deleting Local Branches

Once you have finished with a local feature branch and pushed all your commits to the central repository you can delete the local branch if you no longer require it.

First, you have to change to a different branch:

git checkout master

Then you can delete the feature branch:

git -d <local-branch>

[edit] Remote Feature Development

This example workflow is for working on new features in a feature branch hosted on the central repository. This workflow is recommended for larger features or where there are many developers on a project.

The main disadvantage of local feature branch development is no-one else can see your code changes or help you until the finished feature is pushed to master on the central repository. You could resolve this by regularly pushing incomplete features to master, but this will lead to master becoming more unstable. The proper solution is to create a Remote Feature Branch on the central repository where you can push your interim work for others to see and also push changes to.

TODO: Finish this.

TODO Steps:

  • Create the remote branch tracking master
 git push origin master:refs/heads/<remote-branch>
 git fetch origin
  • Create your local branch tracking the remote branch
 git branch --track <local-branch> origin/<remote-branch>
 git checkout <local-branch>
  • Do local dev and commits, rebase, push
  • When to use Merges, when to Rebase?
  • Once local commits are pushed you cannot rewrite them!

[edit] Local Bug Fixing

This example workflow is for locally fixing bugs in both the stable and unstable branches and pushing them to the central repository.

In Git, stable branches are just regular branches that have special meaning to a project and possibly a special naming scheme to distinguish them. For example, kdelibs includes the following branches on the central repository:

 origin/HEAD -> origin/master
 origin/KDE/4.5
 origin/KDE/4.6
 origin/kdecore/klocale-win
 origin/kdeui/kdatetimeedit
 origin/master

Here origin/KDE/4.6 is the 4.6 release of kdelibs.

Making bug fixes to stable branches is thus fundamentally the same as working on a feature branch, but with the added step of needing to push the bug fix to both the stable and unstable branch in the central repository.

In the Simple Workflow bug fixing section we describe a simple way to perform bug fixes for both stable and unstable branches in the same repository clone.

The basic workflow works fine except switching between unstable and stable branches inside a single Git repository can lead to large rebuilds if the unstable branch has diverged too much from the stable branch. On a small app this overhead may be small enough to not be a problem, but in most cases this constant rebuilding will be a waste of time.

One alternative is to have two separate clones using two separate build environments, but this wastes disk space and causes problems with keeping the separate clones in sync.

A better alternative is to use the git-new-workdir script to create separate work directories and builds for the stable and unstable branches using the same repository clone. This depends on you setting different up KDE Environments for the separate builds.

TODO: Finish this.


This page was last modified on 13 June 2011, at 18:26. This page has been accessed 4,658 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal