[github/shaarli/Shaarli.git] / doc / html / Versioning-and-Branches / index.html

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  
  <link rel="shortcut icon" href="../img/favicon.ico">
  <title>Versioning and Branches - Shaarli Documentation</title>
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="../css/highlight.css">
  <link href="../github-markdown.css" rel="stylesheet">
  
  <script>
    // Current page data
    var mkdocs_page_name = "Versioning and Branches";
    var mkdocs_page_input_path = "Versioning-and-Branches.md";
    var mkdocs_page_url = "/Versioning-and-Branches/";
  </script>
  
  <script src="../js/jquery-2.1.1.min.js"></script>
  <script src="../js/modernizr-2.8.3.min.js"></script>
  <script type="text/javascript" src="../js/highlight.pack.js"></script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href=".." class="icon icon-home"> Shaarli Documentation</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	<ul class="current">
	  
          
            <li class="toctree-l1">
		
    <a class="" href="..">Home</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Setup</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../Download-and-Installation/">Download and Installation</a>
                </li>
                <li class="">
                    
    <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
                </li>
                <li class="">
                    
    <a class="" href="../Server-requirements/">Server requirements</a>
                </li>
                <li class="">
                    
    <a class="" href="../Server-configuration/">Server configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../Server-security/">Server security</a>
                </li>
                <li class="">
                    
    <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../Plugins/">Plugins</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Docker</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../docker/docker-101/">Docker 101</a>
                </li>
                <li class="">
                    
    <a class="" href="../docker/shaarli-images/">Shaarli images</a>
                </li>
                <li class="">
                    
    <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../docker/resources/">Docker resources</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Usage</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../Features/">Features</a>
                </li>
                <li class="">
                    
    <a class="" href="../Bookmarklet/">Bookmarklet</a>
                </li>
                <li class="">
                    
    <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
                </li>
                <li class="">
                    
    <a class="" href="../Firefox-share/">Firefox share</a>
                </li>
                <li class="">
                    
    <a class="" href="../RSS-feeds/">RSS feeds</a>
                </li>
                <li class="">
                    
    <a class="" href="../REST-API/">REST API</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">How To</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
                </li>
                <li class="">
                    
    <a class="" href="../Various-hacks/">Various hacks</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="../Troubleshooting/">Troubleshooting</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Development</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../Development-guidelines/">Development guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
                </li>
                <li class="">
                    
    <a class="" href="../GnuPG-signature/">GnuPG signature</a>
                </li>
                <li class="">
                    
    <a class="" href="../Coding-guidelines/">Coding guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="../Directory-structure/">Directory structure</a>
                </li>
                <li class="">
                    
    <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
                </li>
                <li class="">
                    
    <a class="" href="../Plugin-System/">Plugin System</a>
                </li>
                <li class="">
                    
    <a class="" href="../Release-Shaarli/">Release Shaarli</a>
                </li>
                <li class=" current">
                    
    <a class="current" href="./">Versioning and Branches</a>
    <ul class="subnav">
            
    <li class="toctree-l3"><a href="#master-branch">master branch</a></li>
    

    <li class="toctree-l3"><a href="#v0x-branch">v0.x branch</a></li>
    

    <li class="toctree-l3"><a href="#latest-branch">latest branch</a></li>
    

    <li class="toctree-l3"><a href="#stable-branch">stable branch</a></li>
    

    <li class="toctree-l3"><a href="#releases">Releases</a></li>
    

    <li class="toctree-l3"><a href="#advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</a></li>
    
        <ul>
        
            <li><a class="toctree-l4" href="#versioning">Versioning</a></li>
        
            <li><a class="toctree-l4" href="#major-bugfix-backport-releases">Major bugfix backport releases</a></li>
        
        </ul>
    

    </ul>
                </li>
                <li class="">
                    
    <a class="" href="../Security/">Security</a>
                </li>
                <li class="">
                    
    <a class="" href="../Static-analysis/">Static analysis</a>
                </li>
                <li class="">
                    
    <a class="" href="../Theming/">Theming</a>
                </li>
                <li class="">
                    
    <a class="" href="../Unit-tests/">Unit tests</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">About</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../FAQ/">FAQ</a>
                </li>
                <li class="">
                    
    <a class="" href="../Community-&-Related-software/">Community & Related software</a>
                </li>
    </ul>
	    </li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="..">Shaarli Documentation</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="..">Docs</a> &raquo;</li>
    
      
        
          <li>Development &raquo;</li>
        
      
    
    <li>Versioning and Branches</li>
    <li class="wy-breadcrumbs-aside">
      
        <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Versioning-and-Branches.md"
          class="icon icon-github"> Edit on GitHub</a>
      
    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <p><strong>WORK IN PROGRESS</strong></p>
<p>It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.</p>
<h2 id="master-branch"><code>master</code> branch</h2>
<p>The <code>master</code> branch is the development branch. Any new change MUST go through this branch using Pull Requests.</p>
<p>Remarks:</p>
<ul>
<li>This branch shouldn't be used for production as it isn't necessary stable.</li>
<li>3rd party aren't required to be compatible with the latest changes.</li>
<li>Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.</li>
<li>The version in this branch is always <code>dev</code>.</li>
</ul>
<h2 id="v0x-branch"><code>v0.x</code> branch</h2>
<p>This <code>v0.x</code> branch, points to the latest <code>v0.x.y</code> release.</p>
<p>Explanation:</p>
<p>When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.</p>
<p>In this case, the issue is fixed in the <code>master</code> branch, and the fix is backported the to the <code>v0.x</code> branch. Then a new release is made from the <code>v0.x</code> branch.</p>
<p>This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.</p>
<h2 id="latest-branch"><code>latest</code> branch</h2>
<p>This branch point the latest release. It recommended to use it to get the latest tested changes.</p>
<h2 id="stable-branch"><code>stable</code> branch</h2>
<p>The <code>stable</code> branch doesn't contain any major bug, and is one major digit version behind the latest release.</p>
<p>For example, the current latest release is <code>v0.8.3</code>, the stable branch is an alias to the latest <code>v0.7.x</code> release. When the <code>v0.9.0</code> version will be released, the stable will move to the latest <code>v0.8.x</code> release.</p>
<p>Remarks:</p>
<ul>
<li>Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.</li>
</ul>
<h2 id="releases">Releases</h2>
<p>Releases are always made from the latest <code>v0.x</code> branch.</p>
<p>Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.</p>
<h2 id="advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</h2>
<h3 id="versioning">Versioning</h3>
<p>Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the <a href="https://github.com/shaarli/Shaarli/releases">changelog</a> (<em>Draft</em> means not released yet) and the commit log (like <a href="https://github.com/shaarli/Shaarli/commits/master/tpl/default"><code>tpl</code> folder</a> for themes)). You can either:</p>
<ul>
<li>use the Shaarli version number, with your repo version. For example, if Shaarli <code>v0.8.3</code> is released, publish a <code>v0.8.3-1</code> release, where <code>v0.8.3</code> states Shaarli compatibility and <code>-1</code> is your own version digit for the current Shaarli version.</li>
<li>use your own versioning scheme, and state Shaarli compatibility in the release description.</li>
</ul>
<p>Using this, any user will be able to pick the release matching his own Shaarli version.</p>
<h3 id="major-bugfix-backport-releases">Major bugfix backport releases</h3>
<p>To be able to support backported fixes, it recommended to use our workflow:</p>
<pre><code class="bash"># In master, fix the major bug
git commit -m &quot;Katastrophe&quot;
git push origin master
# Get your commit hash
git log --format=&quot;%H&quot; -n 1
# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)
git checkout -b katastrophe v0.8.2-1
# Backport the fix commit to your brand new branch
git cherry-pick &lt;fix commit hash&gt;
git push origin katastrophe
# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`
</code></pre>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../Security/" class="btn btn-neutral float-right" title="Security">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
        <a href="../Release-Shaarli/" class="btn btn-neutral" title="Release Shaarli"><span class="icon icon-circle-arrow-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
	  
        </div>
      </div>

    </section>
    
  </div>

  <div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
      
      
        <span><a href="../Release-Shaarli/" style="color: #fcfcfc;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../Security/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script src="../js/theme.js"></script>

</body>
</html>
Commit	Line	Data
53ed6d7d	1	<!DOCTYPE html>
	2	<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
	3	<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
	4	<head>
	5	<meta charset="utf-8">
	6	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	7	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	8
	9
	10	<link rel="shortcut icon" href="../img/favicon.ico">
	11	<title>Versioning and Branches - Shaarli Documentation</title>
	12	<link href='https://fonts.googleapis.com/css?family=Lato:400,700\|Roboto+Slab:400,700\|Inconsolata:400,700' rel='stylesheet' type='text/css'>
	13
	14	<link rel="stylesheet" href="../css/theme.css" type="text/css" />
	15	<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
	16	<link rel="stylesheet" href="../css/highlight.css">
	17	<link href="../github-markdown.css" rel="stylesheet">
	18
	19	<script>
	20	// Current page data
	21	var mkdocs_page_name = "Versioning and Branches";
	22	var mkdocs_page_input_path = "Versioning-and-Branches.md";
	23	var mkdocs_page_url = "/Versioning-and-Branches/";
	24	</script>
	25
	26	<script src="../js/jquery-2.1.1.min.js"></script>
	27	<script src="../js/modernizr-2.8.3.min.js"></script>
	28	<script type="text/javascript" src="../js/highlight.pack.js"></script>
	29
	30	</head>
	31
	32	<body class="wy-body-for-nav" role="document">
	33
	34	<div class="wy-grid-for-nav">
	35
	36
	37	<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
	38	<div class="wy-side-nav-search">
	39	<a href=".." class="icon icon-home"> Shaarli Documentation</a>
	40	<div role="search">
	41	<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
	42	<input type="text" name="q" placeholder="Search docs" />
	43	</form>
	44	</div>
	45	</div>
	46
	47	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	48	<ul class="current">
	49
	50
	51	<li class="toctree-l1">
	52
	53	<a class="" href="..">Home</a>
	54	</li>
	55
	56	<li class="toctree-l1">
	57
	58	<span class="caption-text">Setup</span>
	59	<ul class="subnav">
	60	<li class="">
	61
	62	<a class="" href="../Download-and-Installation/">Download and Installation</a>
	63	</li>
	64	<li class="">
65
66	<a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
67	</li>
68	<li class="">
69
70	<a class="" href="../Server-requirements/">Server requirements</a>
71	</li>
72	<li class="">
73
74	<a class="" href="../Server-configuration/">Server configuration</a>
75	</li>
76	<li class="">
77
78	<a class="" href="../Server-security/">Server security</a>
79	</li>
80	<li class="">
81
82	<a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
83	</li>
84	<li class="">
85
86	<a class="" href="../Plugins/">Plugins</a>
87	</li>
88	</ul>
89	</li>
90
91	<li class="toctree-l1">
92
93	<span class="caption-text">Docker</span>
94	<ul class="subnav">
95	<li class="">
96
3a6f91a9	97	<a class="" href="../docker/docker-101/">Docker 101</a>
53ed6d7d	98	</li>
	99	<li class="">
	100
3a6f91a9	101	<a class="" href="../docker/shaarli-images/">Shaarli images</a>
53ed6d7d	102	</li>
	103	<li class="">
	104
3a6f91a9	105	<a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
53ed6d7d	106	</li>
	107	<li class="">
	108
3a6f91a9	109	<a class="" href="../docker/resources/">Docker resources</a>
53ed6d7d	110	</li>
	111	</ul>
	112	</li>
	113
	114	<li class="toctree-l1">
	115
	116	<span class="caption-text">Usage</span>
	117	<ul class="subnav">
	118	<li class="">
	119
	120	<a class="" href="../Features/">Features</a>
	121	</li>
	122	<li class="">
	123
	124	<a class="" href="../Bookmarklet/">Bookmarklet</a>
	125	</li>
	126	<li class="">
	127
	128	<a class="" href="../Browsing-and-searching/">Browsing and searching</a>
	129	</li>
	130	<li class="">
	131
	132	<a class="" href="../Firefox-share/">Firefox share</a>
	133	</li>
	134	<li class="">
	135
	136	<a class="" href="../RSS-feeds/">RSS feeds</a>
	137	</li>
	138	<li class="">
	139
	140	<a class="" href="../REST-API/">REST API</a>
	141	</li>
	142	</ul>
	143	</li>
	144
	145	<li class="toctree-l1">
	146
	147	<span class="caption-text">How To</span>
	148	<ul class="subnav">
	149	<li class="">
	150
	151	<a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
	152	</li>
	153	<li class="">
	154
0433c688	155	<a class="" href="../Various-hacks/">Various hacks</a>
53ed6d7d	156	</li>
	157	</ul>
	158	</li>
	159
	160	<li class="toctree-l1">
	161
	162	<a class="" href="../Troubleshooting/">Troubleshooting</a>
	163	</li>
	164
	165	<li class="toctree-l1">
	166
	167	<span class="caption-text">Development</span>
	168	<ul class="subnav">
	169	<li class="">
	170
	171	<a class="" href="../Development-guidelines/">Development guidelines</a>
	172	</li>
	173	<li class="">
	174
	175	<a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
	176	</li>
	177	<li class="">
	178
	179	<a class="" href="../GnuPG-signature/">GnuPG signature</a>
	180	</li>
	181	<li class="">
	182
	183	<a class="" href="../Coding-guidelines/">Coding guidelines</a>
	184	</li>
	185	<li class="">
	186
	187	<a class="" href="../Directory-structure/">Directory structure</a>
	188	</li>
	189	<li class="">
	190
	191	<a class="" href="../3rd-party-libraries/">3rd party libraries</a>
	192	</li>
	193	<li class="">
	194
	195	<a class="" href="../Plugin-System/">Plugin System</a>
	196	</li>
	197	<li class="">
	198
	199	<a class="" href="../Release-Shaarli/">Release Shaarli</a>
	200	</li>
	201	<li class=" current">
	202
	203	<a class="current" href="./">Versioning and Branches</a>
	204	<ul class="subnav">
	205
	206	<li class="toctree-l3"><a href="#master-branch">master branch</a></li>
	207
	208
	209	<li class="toctree-l3"><a href="#v0x-branch">v0.x branch</a></li>
	210
	211
	212	<li class="toctree-l3"><a href="#latest-branch">latest branch</a></li>
	213
	214
	215	<li class="toctree-l3"><a href="#stable-branch">stable branch</a></li>
	216
	217
	218	<li class="toctree-l3"><a href="#releases">Releases</a></li>
	219
220
221	<li class="toctree-l3"><a href="#advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</a></li>
222
223	<ul>
224
225	<li><a class="toctree-l4" href="#versioning">Versioning</a></li>
226
227	<li><a class="toctree-l4" href="#major-bugfix-backport-releases">Major bugfix backport releases</a></li>
228
229	</ul>
230
231
232	</ul>
233	</li>
234	<li class="">
235
236	<a class="" href="../Security/">Security</a>
237	</li>
238	<li class="">
239
240	<a class="" href="../Static-analysis/">Static analysis</a>
241	</li>
242	<li class="">
243
244	<a class="" href="../Theming/">Theming</a>
245	</li>
246	<li class="">
247
248	<a class="" href="../Unit-tests/">Unit tests</a>
249	</li>
250	</ul>
251	</li>
252
253	<li class="toctree-l1">
254
255	<span class="caption-text">About</span>
256	<ul class="subnav">
257	<li class="">
258
259	<a class="" href="../FAQ/">FAQ</a>
260	</li>
261	<li class="">
262
263	<a class="" href="../Community-&-Related-software/">Community & Related software</a>
264	</li>
265	</ul>
266	</li>
267
268	</ul>
269	</div>
270
271	</nav>
272
273	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
274
275
276	<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
277	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
278	<a href="..">Shaarli Documentation</a>
279	</nav>
280
281
282	<div class="wy-nav-content">
283	<div class="rst-content">
284	<div role="navigation" aria-label="breadcrumbs navigation">
285	<ul class="wy-breadcrumbs">
286	<li><a href="..">Docs</a> »</li>
287
288
289
290	<li>Development »</li>
291
292
293
294	<li>Versioning and Branches</li>
295	<li class="wy-breadcrumbs-aside">
296
297	<a href="https://github.com/shaarli/Shaarli/edit/master/docs/Versioning-and-Branches.md"
298	class="icon icon-github"> Edit on GitHub</a>
299
300	</li>
301	</ul>
302	<hr/>
303	</div>
304	<div role="main">
305	<div class="section">
306
307	<p><strong>WORK IN PROGRESS</strong></p>
308	<p>It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.</p>
309	<h2 id="master-branch"><code>master</code> branch</h2>
310	<p>The <code>master</code> branch is the development branch. Any new change MUST go through this branch using Pull Requests.</p>
311	<p>Remarks:</p>
312	<ul>
313	<li>This branch shouldn't be used for production as it isn't necessary stable.</li>
314	<li>3rd party aren't required to be compatible with the latest changes.</li>
315	<li>Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.</li>
316	<li>The version in this branch is always <code>dev</code>.</li>
317	</ul>
318	<h2 id="v0x-branch"><code>v0.x</code> branch</h2>
319	<p>This <code>v0.x</code> branch, points to the latest <code>v0.x.y</code> release.</p>
320	<p>Explanation:</p>
321	<p>When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.</p>
322	<p>In this case, the issue is fixed in the <code>master</code> branch, and the fix is backported the to the <code>v0.x</code> branch. Then a new release is made from the <code>v0.x</code> branch.</p>
323	<p>This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.</p>
324	<h2 id="latest-branch"><code>latest</code> branch</h2>
325	<p>This branch point the latest release. It recommended to use it to get the latest tested changes.</p>
326	<h2 id="stable-branch"><code>stable</code> branch</h2>
327	<p>The <code>stable</code> branch doesn't contain any major bug, and is one major digit version behind the latest release.</p>
328	<p>For example, the current latest release is <code>v0.8.3</code>, the stable branch is an alias to the latest <code>v0.7.x</code> release. When the <code>v0.9.0</code> version will be released, the stable will move to the latest <code>v0.8.x</code> release.</p>
329	<p>Remarks:</p>
330	<ul>
331	<li>Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.</li>
332	</ul>
333	<h2 id="releases">Releases</h2>
334	<p>Releases are always made from the latest <code>v0.x</code> branch.</p>
335	<p>Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.</p>
336	<h2 id="advices-on-3rd-party-git-repos-workflow">Advices on 3rd party git repos workflow</h2>
337	<h3 id="versioning">Versioning</h3>
338	<p>Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the <a href="https://github.com/shaarli/Shaarli/releases">changelog</a> (<em>Draft</em> means not released yet) and the commit log (like <a href="https://github.com/shaarli/Shaarli/commits/master/tpl/default"><code>tpl</code> folder</a> for themes)). You can either:</p>
339	<ul>
340	<li>use the Shaarli version number, with your repo version. For example, if Shaarli <code>v0.8.3</code> is released, publish a <code>v0.8.3-1</code> release, where <code>v0.8.3</code> states Shaarli compatibility and <code>-1</code> is your own version digit for the current Shaarli version.</li>
341	<li>use your own versioning scheme, and state Shaarli compatibility in the release description.</li>
342	</ul>
343	<p>Using this, any user will be able to pick the release matching his own Shaarli version.</p>
344	<h3 id="major-bugfix-backport-releases">Major bugfix backport releases</h3>
345	<p>To be able to support backported fixes, it recommended to use our workflow:</p>
346	<pre><code class="bash"># In master, fix the major bug
347	git commit -m "Katastrophe"
348	git push origin master
349	# Get your commit hash
350	git log --format="%H" -n 1
351	# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)
352	git checkout -b katastrophe v0.8.2-1
353	# Backport the fix commit to your brand new branch
354	git cherry-pick <fix commit hash>
355	git push origin katastrophe
356	# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`
357	</code></pre>
358
359	</div>
360	</div>
361	<footer>
362
363	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
364
365	<a href="../Security/" class="btn btn-neutral float-right" title="Security">Next <span class="icon icon-circle-arrow-right"></span></a>
366
367
368	<a href="../Release-Shaarli/" class="btn btn-neutral" title="Release Shaarli"><span class="icon icon-circle-arrow-left"></span> Previous</a>
369
370	</div>
371
372
373	<hr/>
374
375	<div role="contentinfo">
376	<!-- Copyright etc -->
377
378	</div>
379
380	Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
381	</footer>
382
383	</div>
384	</div>
385
386	</section>
387
388	</div>
389
390	<div class="rst-versions" role="note" style="cursor: pointer">
391	<span class="rst-current-version" data-toggle="rst-current-version">
392
393	<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
394
395
396	<span><a href="../Release-Shaarli/" style="color: #fcfcfc;">« Previous</a></span>
397
398
399	<span style="margin-left: 15px"><a href="../Security/" style="color: #fcfcfc">Next »</a></span>
400
401	</span>
402	</div>
403	<script src="../js/theme.js"></script>
404
405	</body>
406	</html>