2011-04-20 12:29:01 +00:00
<?xml version="1.0" encoding="utf-8"?>
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "fr" xml:lang = "fr" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< meta name = "keywords" content = "git, protection, branches, diverged" >
2011-04-20 13:56:52 +00:00
< link rel = "shortcut icon" type = "image/x-icon" href = "/Scratch/img/favicon.ico" / >
< link rel = "stylesheet" type = "text/css" href = "/Scratch/assets/css/main.css" / >
2012-04-02 21:43:39 +00:00
< link rel = "stylesheet" type = "text/css" href = "/Scratch/css/solarized.css" / >
2011-04-20 13:56:52 +00:00
< link rel = "stylesheet" type = "text/css" href = "/Scratch/css/idc.css" / >
2011-04-20 12:29:01 +00:00
< link rel = "alternate" type = "application/rss+xml" title = "RSS" href = "http://feeds.feedburner.com/yannespositocomen" / >
2011-04-20 13:56:52 +00:00
< link rel = "alternate" lang = "fr" xml:lang = "fr" title = "Encapsuler git" type = "text/html" hreflang = "fr" href = "/Scratch/fr/blog/2010-03-23-Encapsulate-git/" / >
< link rel = "alternate" lang = "en" xml:lang = "en" title = "Encapsulate git" type = "text/html" hreflang = "en" href = "/Scratch/en/blog/2010-03-23-Encapsulate-git/" / >
< script type = "text/javascript" src = "/Scratch/js/jquery-1.3.1.min.js" > < / script >
< script type = "text/javascript" src = "/Scratch/js/jquery.cookie.js" > < / script >
< script type = "text/javascript" src = "/Scratch/js/index.js" > < / script >
2011-04-20 12:29:01 +00:00
<!-- [if lt IE 9]>
< script src = "http://ie7-js.googlecode.com/svn/version/2.1(beta4)/IE9.js" > < / script >
<![endif]-->
< title > Encapsulate git< / title >
< / head >
2011-10-18 22:30:00 +00:00
< body lang = "en" class = "article" >
2011-04-20 12:29:01 +00:00
< script type = "text/javascript" > / / < ! [ C D A T A [
2011-04-20 13:56:52 +00:00
document.write('< div id = "blackpage" > < img src = "/Scratch/img/loading.gif" alt = "loading..." / > < / div > ');
2011-04-20 12:29:01 +00:00
// ]]>
< / script >
< div id = "content" >
< div id = "choix" >
< div class = "return" > < a href = "#entete" > ↓ Menu ↓ < / a > < / div >
< div id = "choixlang" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/fr/blog/2010-03-23-Encapsulate-git/" onclick = "setLanguage('fr')" > en Français< / a >
2011-04-20 12:29:01 +00:00
< / div >
2011-09-28 16:05:55 +00:00
< div class = "flush" > < / div >
2011-04-20 12:29:01 +00:00
< / div >
< div id = "titre" >
< h1 >
Encapsulate git
< / h1 >
< / div >
< div class = "flush" > < / div >
< div class = "flush" > < / div >
< div id = "afterheader" >
< div class = "corps" >
< div class = "intro" >
Here is a solution to maintain divergent branches in git. Because it is easy to merge by mistake. I give a script that encapsulate git in order to forbid some merge and warn you some merge should be dangerous.
< / div >
< h2 id = "how-to-protect-against-your-own-dumb" > how to protect against your own dumb< / h2 >
< p > I work on a project in which some of my git branches should remain divergent. And divergences should grow.< / p >
< p > I also use some branch to contain what is common between projects.< / p >
< p > Say I have some branches:< / p >
< p > master: common to all branches
dev: branch devoted to unstable development
client: branch with features for all client but not general enough for master
clientA: project adapted for client A
clientB: project adapted for client B< / p >
< p > Here how I want to work: < / p >
2011-04-20 13:56:52 +00:00
< p > < img alt = "Dynamic branching" src = "/Scratch/img/blog/2010-03-23-Encapsulate-git/dynamic_branching.png" / > < / p >
2011-04-20 12:29:01 +00:00
< p > And more precisely the branch hierarchy: < / p >
2011-04-20 13:56:52 +00:00
< p > < img alt = "Branch hierarchy" src = "/Scratch/img/blog/2010-03-23-Encapsulate-git/branch_hierarchy.png" / > < / p >
2011-04-20 12:29:01 +00:00
< p > An arrow from A to B means, you can merge A in B. If there is no arrow from A to B that means it is < em > forbidden< / em > to merge A in B. Here is the corresponding rubycode:< / p >
< div > < pre class = "twilight" >
< span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > < span class = "Keyword" > =< / span > {
< span class = "Constant" > < span class = "Constant" > :< / span > master< / span > => [ < span class = "Constant" > < span class = "Constant" > :< / span > dev< / span > , < span class = "Constant" > < span class = "Constant" > :< / span > client< / span > ],
< span class = "Constant" > < span class = "Constant" > :< / span > dev< / span > => [ < span class = "Constant" > < span class = "Constant" > :< / span > master< / span > ],
< span class = "Constant" > < span class = "Constant" > :< / span > client< / span > => [ < span class = "Constant" > < span class = "Constant" > :< / span > clientA< / span > , < span class = "Constant" > < span class = "Constant" > :< / span > clientB< / span > ] }
< / pre > < / div >
< p > Having a < code > :master => [ :dev, :client ]< / code > means you can merge < code > master< / code > branch into < code > dev< / code > and < code > client< / code > .< / p >
< p > If by mistake I make a < code > git checkout master & & git merge clientA< / code > , I made a mistake. This is why I made a script which encapsulate the git behaviour to dodge this kind of mistake.< / p >
< p > But this script do far more than that. It also merge from top to down. The action < code > allmerges< / code > will do:< / p >
< div > < pre class = "twilight" >
git co dev < span class = "Keyword" > & & < / span > git merge master
git co client < span class = "Keyword" > & & < / span > git merge master
git co clientA < span class = "Keyword" > & & < / span > git merge client
git co clientB < span class = "Keyword" > & & < / span > git merge client
< / pre > < / div >
< p > That means, I can update all branches. The algorithm will not make loop even if there is a cycle in the branch hierarchy.< / p >
< p > Here it is:< / p >
2011-04-20 13:56:52 +00:00
< div class = "small" > < div class = "code" > < div class = "file" > < a href = "/Scratch/en/blog/2010-03-23-Encapsulate-git/code/eng" > ➥ eng < / a > < / div > < div class = "withfile" >
2011-04-20 12:29:01 +00:00
< pre class = "twilight" >
< span class = "Comment" > < span class = "Comment" > #< / span > !/usr/bin/env ruby< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > encoding: utf-8< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > architecture< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > < / span >
2012-01-11 20:40:22 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > master < -> dev< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > master -> client< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > clien -> clientA | clientB< / span >
2011-04-20 12:29:01 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > < / span >
< span class = "Comment" > < span class = "Comment" > #< / span > merge using two of these branches should be < / span >
< span class = "Comment" > < span class = "Comment" > #< / span > restricted to these rules< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > merge to one of these branch and an unknown one should< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > raise a warning, and may the option to add this new branch< / span >
< span class = "Comment" > < span class = "Comment" > #< / span > to the hierarchy< / span >
< span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > < span class = "Keyword" > =< / span > {
< span class = "Constant" > < span class = "Constant" > :< / span > master< / span > => [ < span class = "Constant" > < span class = "Constant" > :< / span > dev< / span > , < span class = "Constant" > < span class = "Constant" > :< / span > client< / span > ],
< span class = "Constant" > < span class = "Constant" > :< / span > dev< / span > => [ < span class = "Constant" > < span class = "Constant" > :< / span > master< / span > ],
< span class = "Constant" > < span class = "Constant" > :< / span > client< / span > => [ < span class = "Constant" > < span class = "Constant" > :< / span > clientA< / span > , < span class = "Constant" > < span class = "Constant" > :< / span > clientB< / span > ] }
2012-02-20 14:41:09 +00:00
< span class = "Keyword" > def< / span > < span class = "Entity" > get_current_branch< / span > (< span class = "Variable" > < / span > )
2011-04-20 12:29:01 +00:00
(< span class = "String" > < span class = "String" > `< / span > git branch --no-color | awk '$1 == " *" {print $2}'< span class = "String" > `< / span > < / span > ).< span class = "Entity" > chop< / span > .< span class = "Entity" > intern< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > if< / span > < span class = "Variable" > ARGV< / span > .< span class = "Entity" > length< / span > < span class = "Keyword" > ==< / span > < span class = "Constant" > 0< / span >
puts < span class = "String" > < span class = "String" > %{< / span > usage: $0:t [git_command or local_command]< / span >
< span class = "String" > < / span >
< span class = "String" > local commands:< / span >
< span class = "String" > allmerges: merge from top to down< span class = "String" > }< / span > < / span >
exit < span class = "Constant" > 0< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > require< / span > < span class = "String" > < span class = "String" > '< / span > set< span class = "String" > '< / span > < / span >
< span class = "Variable" > < span class = "Variable" > $< / span > known_branches< / span > < span class = "Keyword" > =< / span > < span class = "Support" > Set< / span > .< span class = "Entity" > new< / span >
< span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > .< span class = "Entity" > each< / span > < span class = "Keyword" > do < / span > |< span class = "Variable" > k< / span > ,< span class = "Variable" > v< / span > |
< span class = "Variable" > < span class = "Variable" > $< / span > known_branches< / span > .< span class = "Entity" > add< / span > (k)
v.< span class = "Entity" > each< / span > { |< span class = "Variable" > b< / span > | < span class = "Variable" > < span class = "Variable" > $< / span > known_branches< / span > .< span class = "Entity" > add< / span > (b) }
< span class = "Keyword" > end< / span >
< span class = "Keyword" > def< / span > < span class = "Entity" > rec_merge< / span > (< span class = "Variable" > branch< / span > )
< span class = "Keyword" > if< / span > < span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > [branch].< span class = "Entity" > nil?< / span >
< span class = "Keyword" > return< / span >
< span class = "Keyword" > end< / span >
< span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > [branch].< span class = "Entity" > each< / span > < span class = "Keyword" > do < / span > |< span class = "Variable" > b< / span > |
< span class = "Keyword" > if< / span > < span class = "Variable" > < span class = "Variable" > $< / span > flag< / span > .< span class = "Entity" > has_key?< / span > (b.< span class = "Entity" > to_s< / span > < span class = "Keyword" > +< / span > branch.< span class = "Entity" > to_s< / span > )
< span class = "Keyword" > next< / span >
< span class = "Keyword" > end< / span >
flagname< span class = "Keyword" > =< / span > branch.< span class = "Entity" > to_s< / span > < span class = "Keyword" > +< / span > b.< span class = "Entity" > to_s< / span >
< span class = "Keyword" > if< / span > < span class = "Variable" > < span class = "Variable" > $< / span > flag< / span > .< span class = "Entity" > has_key?< / span > (flagname)
< span class = "Keyword" > next< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > if< / span > system < span class = "String" > < span class = "String" > %{< / span > eng checkout < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > b< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Keyword" > if< / span > get_current_branch < span class = "Keyword" > !=< / span > b
puts < span class = "String" > < span class = "String" > " < / span > Can't checkout to < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > b< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > " < / span > < / span >
exit < span class = "Constant" > 2< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > if< / span > system < span class = "String" > < span class = "String" > %{< / span > eng merge < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > branch< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Variable" > < span class = "Variable" > $< / span > flag< / span > [flagname]< span class = "Keyword" > =< / span > < span class = "Constant" > true< / span >
< span class = "Entity" > rec_merge< / span > (b)
< span class = "Keyword" > else< / span >
exit < span class = "Constant" > 1< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > else< / span >
exit < span class = "Constant" > 1< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > def< / span > < span class = "Entity" > do_all_merges< / span >
puts < span class = "String" > < span class = "String" > '< / span > Will merge from father to sons< span class = "String" > '< / span > < / span >
current_branch< span class = "Keyword" > =< / span > get_current_branch
< span class = "Variable" > < span class = "Variable" > $< / span > flag< / span > < span class = "Keyword" > =< / span > {}
< span class = "Entity" > rec_merge< / span > (< span class = "Constant" > < span class = "Constant" > :< / span > master< / span > )
system < span class = "String" > < span class = "String" > %{< / span > git co < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > current_branch< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > def< / span > < span class = "Entity" > do_merge< / span >
current_branch< span class = "Keyword" > =< / span > get_current_branch
src_branch< span class = "Keyword" > =< / span > < span class = "Variable" > ARGV< / span > [< span class = "Constant" > 1< / span > ].< span class = "Entity" > intern< / span >
puts < span class = "String" > < span class = "String" > %{< / span > do_merge: < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > src_branch< span class = "StringEmbeddedSource" > }< / span > < / span > => < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > current_branch< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Keyword" > if< / span > < span class = "Variable" > < span class = "Variable" > $< / span > known_branches< / span > .< span class = "Entity" > include?< / span > (current_branch)
< span class = "Keyword" > if< / span > < span class = "Variable" > < span class = "Variable" > $< / span > known_branches< / span > .< span class = "Entity" > include?< / span > (src_branch)
< span class = "Keyword" > if< / span > < span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > .< span class = "Entity" > has_key?< / span > (src_branch) < span class = "Keyword" > and< / span >
< span class = "Variable" > < span class = "Variable" > $< / span > architecture< / span > [src_branch].< span class = "Entity" > include?< / span > (current_branch)
system < span class = "String" > < span class = "String" > %{< / span > git merge < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > src_branch< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Keyword" > else< / span >
puts < span class = "String" > < span class = "String" > %{< / span > Forbidden merge: < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > src_branch< span class = "StringEmbeddedSource" > }< / span > < / span > => < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > current_branch< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > else< / span >
puts < span class = "String" > < span class = "String" > %{< / span > Warning! < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > src_branch< span class = "StringEmbeddedSource" > }< / span > < / span > not mentionned in rb configuration< span class = "String" > }< / span > < / span >
sleep < span class = "Constant" > 2< / span >
system < span class = "String" > < span class = "String" > %{< / span > git merge < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > src_branch< span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
puts < span class = "String" > < span class = "String" > %{< / span > Warning! < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > src_branch< span class = "StringEmbeddedSource" > }< / span > < / span > not mentionned in rb configuration< span class = "String" > }< / span > < / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > end< / span >
< span class = "Keyword" > case< / span > < span class = "Variable" > ARGV< / span > [< span class = "Constant" > 0< / span > ]
< span class = "Keyword" > when< / span > < span class = "String" > < span class = "String" > '< / span > allmerges< span class = "String" > '< / span > < / span > < span class = "Keyword" > then< / span > do_all_merges
< span class = "Keyword" > when< / span > < span class = "String" > < span class = "String" > '< / span > merge< span class = "String" > '< / span > < / span > < span class = "Keyword" > then< / span > do_merge
< span class = "Keyword" > else< / span > system < span class = "String" > < span class = "String" > %{< / span > git < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > #{< / span > < span class = "StringVariable" > ARGV< / span > < span class = "StringEmbeddedSource" > < span class = "StringEmbeddedSource" > .< / span > < span class = "Entity" > join< / span > < / span > < span class = "StringEmbeddedSource" > (< / span > < span class = "String" > < span class = "String" > '< / span > < span class = "String" > '< / span > < / span > < span class = "StringEmbeddedSource" > )< / span > < span class = "StringEmbeddedSource" > }< / span > < / span > < span class = "String" > }< / span > < / span >
< span class = "Keyword" > end< / span >
< / pre >
< / div > < / div > < / div >
< p > All you need to do to make it work is simply to copy eng in a directory contained in your PATH.< / p >
< p > Of course try to use as few as possible < code > cherry-pick< / code > and < code > rebase< / code > . This script was intended to work with workflow using < code > pull< / code > and < code > merge< / code > .< / p >
< / div >
< div id = "choixrss" >
< a id = "rss" href = "http://feeds.feedburner.com/yannespositocomen" >
Subscribe
< / a >
< / div >
< script type = "text/javascript" >
$(document).ready(function(){
$('#comment').hide();
$('#clickcomment').click(showComments);
});
function showComments() {
$('#comment').show();
$('#clickcomment').fadeOut();
}
document.write('< div id = "clickcomment" > Comments< / div > ');
< / script >
< div class = "flush" > < / div >
< div class = "corps" id = "comment" >
< h2 class = "first" > comments< / h2 >
< noscript >
You must enable javascript to comment.
< / noscript >
< script type = "text/javascript" >
var idcomments_acct = 'a307f0044511ff1b5cfca573fc0a52e7';
2011-04-20 13:56:52 +00:00
var idcomments_post_id = '/Scratch/en/blog/2010-03-23-Encapsulate-git/';
var idcomments_post_url = 'http://yannesposito.com/Scratch/en/blog/2010-03-23-Encapsulate-git/';
2011-04-20 12:29:01 +00:00
< / script >
< span id = "IDCommentsPostTitle" style = "display:none" > < / span >
2011-04-20 13:56:52 +00:00
< script type = 'text/javascript' src = '/Scratch/js/genericCommentWrapperV2.js' > < / script >
2011-04-20 12:29:01 +00:00
< / div >
< div id = "entete" class = "corps_spaced" >
< div id = "liens" >
2011-04-20 13:56:52 +00:00
< ul > < li > < a href = "/Scratch/en/" > Home< / a > < / li >
< li > < a href = "/Scratch/en/blog/" > Blog< / a > < / li >
< li > < a href = "/Scratch/en/softwares/" > Softwares< / a > < / li >
< li > < a href = "/Scratch/en/about/" > About< / a > < / li > < / ul >
2011-04-20 12:29:01 +00:00
< / div >
< div class = "flush" > < / div >
< hr / >
< div id = "next_before_articles" >
< div id = "previous_articles" >
previous entries
< div class = "previous_article" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/en/blog/2010-03-22-Git-Tips/" > < span class = "nicer" > «< / span > Git Tips< / a >
2011-04-20 12:29:01 +00:00
< / div >
< div class = "previous_article" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/en/blog/2010-02-23-When-regexp-is-not-the-best-solution/" > < span class = "nicer" > «< / span > When regexp is not the best solution< / a >
2011-04-20 12:29:01 +00:00
< / div >
< div class = "previous_article" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/en/blog/2010-02-18-split-a-file-by-keyword/" > < span class = "nicer" > «< / span > split a file by keyword< / a >
2011-04-20 12:29:01 +00:00
< / div >
< / div >
< div id = "next_articles" >
next entries
< div class = "next_article" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/en/blog/2010-05-17-at-least-this-blog-revive/" > I live again! < span class = "nicer" > »< / span > < / a >
2011-04-20 12:29:01 +00:00
< / div >
< div class = "next_article" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/en/blog/2010-05-19-How-to-cut-HTML-and-repair-it/" > How to repair a cutted XML? < span class = "nicer" > »< / span > < / a >
2011-04-20 12:29:01 +00:00
< / div >
< div class = "next_article" >
2011-04-20 13:56:52 +00:00
< a href = "/Scratch/en/blog/2010-05-24-Trees--Pragmatism-and-Formalism/" > Trees; Pragmatism and Formalism < span class = "nicer" > »< / span > < / a >
2011-04-20 12:29:01 +00:00
< / div >
< / div >
< div class = "flush" > < / div >
< / div >
< / div >
< div id = "bottom" >
2012-04-02 21:43:39 +00:00
< div >
< a href = "http://twitter.com/yogsototh" > Follow me< / a >
< / div >
2011-04-20 12:29:01 +00:00
< div >
< a rel = "license" href = "http://creativecommons.org/licenses/by-sa/3.0/" > Copyright ©, Yann Esposito< / a >
< / div >
< div id = "lastmod" >
Created: 03/23/2010
Modified: 05/09/2010
< / div >
< div >
Entirely done with
< a href = "http://www.vim.org" > Vim< / a >
and
< a href = "http://nanoc.stoneship.org" > nanoc< / a >
< / div >
< / div >
< div class = "clear" > < / div >
< / div >
< / body >
< / html >