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]-->
6 <meta http-equiv=
"X-UA-Compatible" content=
"IE=edge">
7 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
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'
>
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">
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/";
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>
32 <body class=
"wy-body-for-nav" role=
"document">
34 <div class=
"wy-grid-for-nav">
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>
41 <form id =
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
42 <input type=
"text" name=
"q" placeholder=
"Search docs" />
47 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
51 <li class=
"toctree-l1">
53 <a class=
"" href=
"..">Home
</a>
56 <li class=
"toctree-l1">
58 <span class=
"caption-text">Setup
</span>
62 <a class=
"" href=
"../Download-and-Installation/">Download and Installation
</a>
66 <a class=
"" href=
"../Upgrade-and-migration/">Upgrade and migration
</a>
70 <a class=
"" href=
"../Server-requirements/">Server requirements
</a>
74 <a class=
"" href=
"../Server-configuration/">Server configuration
</a>
78 <a class=
"" href=
"../Server-security/">Server security
</a>
82 <a class=
"" href=
"../Shaarli-configuration/">Shaarli configuration
</a>
86 <a class=
"" href=
"../Plugins/">Plugins
</a>
91 <li class=
"toctree-l1">
93 <span class=
"caption-text">Docker
</span>
97 <a class=
"" href=
"../Docker-101/">Docker
101</a>
101 <a class=
"" href=
"../Shaarli-images/">Shaarli images
</a>
105 <a class=
"" href=
"../Reverse-proxy-configuration/">Reverse proxy configuration
</a>
109 <a class=
"" href=
"../Docker-resources/">Docker resources
</a>
114 <li class=
"toctree-l1">
116 <span class=
"caption-text">Usage
</span>
120 <a class=
"" href=
"../Features/">Features
</a>
124 <a class=
"" href=
"../Bookmarklet/">Bookmarklet
</a>
128 <a class=
"" href=
"../Browsing-and-searching/">Browsing and searching
</a>
132 <a class=
"" href=
"../Firefox-share/">Firefox share
</a>
136 <a class=
"" href=
"../RSS-feeds/">RSS feeds
</a>
140 <a class=
"" href=
"../REST-API/">REST API
</a>
145 <li class=
"toctree-l1">
147 <span class=
"caption-text">How To
</span>
151 <a class=
"" href=
"../Backup,-restore,-import-and-export/">Backup, restore, import and export
</a>
155 <a class=
"" href=
"../Various-hacks/">Various hacks
</a>
160 <li class=
"toctree-l1">
162 <a class=
"" href=
"../Troubleshooting/">Troubleshooting
</a>
165 <li class=
"toctree-l1">
167 <span class=
"caption-text">Development
</span>
171 <a class=
"" href=
"../Development-guidelines/">Development guidelines
</a>
175 <a class=
"" href=
"../Continuous-integration-tools/">Continuous integration tools
</a>
179 <a class=
"" href=
"../GnuPG-signature/">GnuPG signature
</a>
183 <a class=
"" href=
"../Coding-guidelines/">Coding guidelines
</a>
187 <a class=
"" href=
"../Directory-structure/">Directory structure
</a>
191 <a class=
"" href=
"../3rd-party-libraries/">3rd party libraries
</a>
195 <a class=
"" href=
"../Plugin-System/">Plugin System
</a>
199 <a class=
"" href=
"../Release-Shaarli/">Release Shaarli
</a>
201 <li class=
" current">
203 <a class=
"current" href=
"./">Versioning and Branches
</a>
206 <li class=
"toctree-l3"><a href=
"#master-branch">master branch
</a></li>
209 <li class=
"toctree-l3"><a href=
"#v0x-branch">v0.x branch
</a></li>
212 <li class=
"toctree-l3"><a href=
"#latest-branch">latest branch
</a></li>
215 <li class=
"toctree-l3"><a href=
"#stable-branch">stable branch
</a></li>
218 <li class=
"toctree-l3"><a href=
"#releases">Releases
</a></li>
221 <li class=
"toctree-l3"><a href=
"#advices-on-3rd-party-git-repos-workflow">Advices on
3rd party git repos workflow
</a></li>
225 <li><a class=
"toctree-l4" href=
"#versioning">Versioning
</a></li>
227 <li><a class=
"toctree-l4" href=
"#major-bugfix-backport-releases">Major bugfix backport releases
</a></li>
236 <a class=
"" href=
"../Security/">Security
</a>
240 <a class=
"" href=
"../Static-analysis/">Static analysis
</a>
244 <a class=
"" href=
"../Theming/">Theming
</a>
248 <a class=
"" href=
"../Unit-tests/">Unit tests
</a>
253 <li class=
"toctree-l1">
255 <span class=
"caption-text">About
</span>
259 <a class=
"" href=
"../FAQ/">FAQ
</a>
263 <a class=
"" href=
"../Community-&-Related-software/">Community & Related software
</a>
273 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
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>
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>
290 <li>Development
»</li>
294 <li>Versioning and Branches
</li>
295 <li class=
"wy-breadcrumbs-aside">
297 <a href=
"https://github.com/shaarli/Shaarli/edit/master/docs/Versioning-and-Branches.md"
298 class=
"icon icon-github"> Edit on GitHub
</a>
305 <div class=
"section">
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>
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>
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>
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>
331 <li>Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.
</li>
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>
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>
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`
363 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
365 <a href=
"../Security/" class=
"btn btn-neutral float-right" title=
"Security">Next
<span class=
"icon icon-circle-arrow-right"></span></a>
368 <a href=
"../Release-Shaarli/" class=
"btn btn-neutral" title=
"Release Shaarli"><span class=
"icon icon-circle-arrow-left"></span> Previous
</a>
375 <div role=
"contentinfo">
376 <!-- Copyright etc -->
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>.
390 <div class=
"rst-versions" role=
"note" style=
"cursor: pointer">
391 <span class=
"rst-current-version" data-toggle=
"rst-current-version">
393 <a href=
"https://github.com/shaarli/Shaarli" class=
"fa fa-github" style=
"float: left; color: #fcfcfc"> GitHub
</a>
396 <span><a href=
"../Release-Shaarli/" style=
"color: #fcfcfc;">« Previous
</a></span>
399 <span style=
"margin-left: 15px"><a href=
"../Security/" style=
"color: #fcfcfc">Next
»</a></span>
403 <script src=
"../js/theme.js"></script>