yogsototh/scratch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
scratch/output/Scratch/en/blog/2010-03-23-Encapsulate-git/index.html
Yann Esposito (Yogsototh) e898fd70f7 regeneration
2010-10-14 15:22:58 +02:00

335 lines
No EOL
22 KiB
HTML
Raw Blame History

<?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">
<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" />
<link rel="stylesheet" type="text/css" href="/Scratch/css/twilight.css" />
<link rel="stylesheet" type="text/css" href="/Scratch/css/idc.css" />
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://feeds.feedburner.com/yannespositocomen"/>
<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>
<title>Encapsulate git</title>
</head>
<body lang="en">
<script type="text/javascript">// <![CDATA[
document.write('<div id="blackpage"><img src="/Scratch/img/loading.gif" alt="loading..."/></div>');
// ]]>
</script>
<div id="content">
<div id="choix">
<div class="return"><a href="#entete">&darr; Menu &darr;</a></div>
<div id="choixlang">
<a href="/Scratch/fr/blog/2010-03-23-Encapsulate-git/" onclick="setLanguage('fr')">en Français</a>
</div>
</div>
<img src="/Scratch/img/presentation.png" alt="Presentation drawing"/>
<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>
<p><img alt="Dynamic branching" src="/Scratch/img/blog/2010-03-23-Encapsulate-git/dynamic_branching.png" /></p>
<p>And more precisely the branch hierarchy: </p>
<p><img alt="Branch hierarchy" src="/Scratch/img/blog/2010-03-23-Encapsulate-git/branch_hierarchy.png" /></p>
<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> =&gt; [ <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> =&gt; [ <span class="Constant"><span class="Constant">:</span>master</span> ],
<span class="Constant"><span class="Constant">:</span>client</span> =&gt; [ <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 =&gt; [ :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 &amp;&amp; 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">&amp;&amp;</span> git merge master
git co client <span class="Keyword">&amp;&amp;</span> git merge master
git co clientA <span class="Keyword">&amp;&amp;</span> git merge client
git co clientB <span class="Keyword">&amp;&amp;</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>
<div class="small"><div class="code"><div class="file"><a href="/Scratch/en/blog/2010-03-23-Encapsulate-git/code/eng"> &#x27A5; eng </a></div><div class="withfile">
<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>
<span class="Comment"><span class="Comment">#</span> master &lt;&rarr; dev</span>
<span class="Comment"><span class="Comment">#</span> master &rarr; client</span>
<span class="Comment"><span class="Comment">#</span> clien &rarr; clientA | clientB</span>
<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> =&gt; [ <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> =&gt; [ <span class="Constant"><span class="Constant">:</span>master</span> ],
<span class="Constant"><span class="Constant">:</span>client</span> =&gt; [ <span class="Constant"><span class="Constant">:</span>clientA</span>, <span class="Constant"><span class="Constant">:</span>clientB</span> ] }
<span class="Keyword">def</span> <span class="Entity">get_current_branch</span>(<span class="Variable" />)
(<span class="String"><span class="String">`</span>git branch --no-color | awk '$1 == &quot;*&quot; {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">&quot;</span>Can't checkout to <span class="StringEmbeddedSource"><span class="StringEmbeddedSource">#{</span>b<span class="StringEmbeddedSource">}</span></span><span class="String">&quot;</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> =&gt; <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> =&gt; <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>
Vous devez activer javascript pour commenter.
</noscript>
<script type="text/javascript">
var idcomments_acct = 'a307f0044511ff1b5cfca573fc0a52e7';
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/';
</script>
<span id="IDCommentsPostTitle" style="display:none"></span>
<script type='text/javascript' src='/Scratch/js/genericCommentWrapperV2.js'></script>
</div>
<div id="entete" class="corps_spaced">
<div id="liens">
<ul><li><a href="/Scratch/en/">Homepage</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>
</div>
<div class="flush"></div>
<hr/>
<div id="next_before_articles">
<div id="previous_articles">
previous entries
<div class="previous_article">
<a href="/Scratch/en/blog/2010-03-22-Git-Tips/"><span class="nicer">«</span>&nbsp;Git Tips</a>
</div>
<div class="previous_article">
<a href="/Scratch/en/blog/2010-02-23-When-regexp-is-not-the-best-solution/"><span class="nicer">«</span>&nbsp;When regexp is not the best solution</a>
</div>
<div class="previous_article">
<a href="/Scratch/en/blog/2010-02-18-split-a-file-by-keyword/"><span class="nicer">«</span>&nbsp;split a file by keyword</a>
</div>
</div>
<div id="next_articles">
next entries
<div class="next_article">
<a href="/Scratch/en/blog/2010-05-17-at-least-this-blog-revive/">I live again!&nbsp;<span class="nicer">»</span></a>
</div>
<div class="next_article">
<a href="/Scratch/en/blog/2010-05-19-How-to-cut-HTML-and-repair-it/">How to repair a cutted XML?&nbsp;<span class="nicer">»</span></a>
</div>
<div class="next_article">
<a href="/Scratch/en/blog/2010-05-24-Trees--Pragmatism-and-Formalism/">Trees; Pragmatism and Formalism&nbsp;<span class="nicer">»</span></a>
</div>
</div>
<div class="flush"></div>
</div>
</div>
<div id="bottom">
<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>
<a href="/Scratch/en/validation/">Validation</a>
<a href="http://validator.w3.org/check?uri=referer"> [xhtml] </a>
.
<a href="http://jigsaw.w3.org/css-validator/check/referer?profile=css3"> [css] </a>
.
<a href="http://validator.w3.org/feed/check.cgi?url=http%3A//yannesposito.com/Scratch/en/blog/feed/feed.xml">[rss]</a>
</div>
</div>
<div class="clear"></div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink