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>Release Shaarli - 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 = "Release Shaarli";
22 var mkdocs_page_input_path = "Release-Shaarli.md";
23 var mkdocs_page_url = "/Release-Shaarli/";
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>
197 <li class=
" current">
199 <a class=
"current" href=
"./">Release Shaarli
</a>
202 <li class=
"toctree-l3"><a href=
"#prerequisites">Prerequisites
</a></li>
205 <li class=
"toctree-l3"><a href=
"#github-release-draft-and-changelogmd">GitHub release draft and CHANGELOG.md
</a></li>
209 <li><a class=
"toctree-l4" href=
"#github-release-draft">GitHub release draft
</a></li>
211 <li><a class=
"toctree-l4" href=
"#changelogmd">CHANGELOG.md
</a></li>
216 <li class=
"toctree-l3"><a href=
"#increment-the-version-code-updated-docs-create-and-push-a-signed-tag">Increment the version code, updated docs, create and push a signed tag
</a></li>
220 <li><a class=
"toctree-l4" href=
"#generate-documentation">Generate documentation
</a></li>
222 <li><a class=
"toctree-l4" href=
"#create-and-merge-a-pull-request">Create and merge a Pull Request
</a></li>
224 <li><a class=
"toctree-l4" href=
"#bump-shaarli-version-to-v0x-branch">Bump Shaarli version to v0.x branch
</a></li>
226 <li><a class=
"toctree-l4" href=
"#create-and-push-a-signed-tag">Create and push a signed tag
</a></li>
228 <li><a class=
"toctree-l4" href=
"#verify-a-signed-tag">Verify a signed tag
</a></li>
233 <li class=
"toctree-l3"><a href=
"#publish-the-github-release">Publish the GitHub release
</a></li>
237 <li><a class=
"toctree-l4" href=
"#update-release-badges">Update release badges
</a></li>
239 <li><a class=
"toctree-l4" href=
"#create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag
</a></li>
241 <li><a class=
"toctree-l4" href=
"#generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives
</a></li>
243 <li><a class=
"toctree-l4" href=
"#update-stable-and-latest-branches">Update stable and latest branches
</a></li>
252 <a class=
"" href=
"../Versioning-and-Branches/">Versioning and Branches
</a>
256 <a class=
"" href=
"../Security/">Security
</a>
260 <a class=
"" href=
"../Static-analysis/">Static analysis
</a>
264 <a class=
"" href=
"../Theming/">Theming
</a>
268 <a class=
"" href=
"../Unit-tests/">Unit tests
</a>
273 <li class=
"toctree-l1">
275 <span class=
"caption-text">About
</span>
279 <a class=
"" href=
"../FAQ/">FAQ
</a>
283 <a class=
"" href=
"../Community-&-Related-software/">Community & Related software
</a>
293 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
296 <nav class=
"wy-nav-top" role=
"navigation" aria-label=
"top navigation">
297 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
298 <a href=
"..">Shaarli Documentation
</a>
302 <div class=
"wy-nav-content">
303 <div class=
"rst-content">
304 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
305 <ul class=
"wy-breadcrumbs">
306 <li><a href=
"..">Docs
</a> »</li>
310 <li>Development
»</li>
314 <li>Release Shaarli
</li>
315 <li class=
"wy-breadcrumbs-aside">
317 <a href=
"https://github.com/shaarli/Shaarli/edit/master/docs/Release-Shaarli.md"
318 class=
"icon icon-github"> Edit on GitHub
</a>
325 <div class=
"section">
327 <p>See
<a href=
"http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases">Git - Maintaining a project - Tagging your
329 <h2 id=
"prerequisites">Prerequisites
</h2>
330 <p>This guide assumes that you have:
331 - a GPG key matching your GitHub authentication credentials
332 - i.e., the email address identified by the GPG key is the same as the one in your
<code>~/.gitconfig
</code>
333 - a GitHub fork of Shaarli
334 - a local clone of your Shaarli fork, with the following remotes:
335 -
<code>origin
</code> pointing to your GitHub fork
336 -
<code>upstream
</code> pointing to the main Shaarli repository
337 - maintainer permissions on the main Shaarli repository, to:
338 - push the signed tag
339 - create a new release
340 -
<a href=
"https://getcomposer.org/">Composer
</a> needs to be installed
341 - The
<a href=
"https://docs.python.org/3/library/venv.html">venv
</a> Python
3 module needs to be installed for HTML documentation generation.
</p>
342 <h2 id=
"github-release-draft-and-changelogmd">GitHub release draft and
<code>CHANGELOG.md
</code></h2>
343 <p>See http://keepachangelog.com/en/
0.3.0/ for changelog formatting.
</p>
344 <h3 id=
"github-release-draft">GitHub release draft
</h3>
345 <p>GitHub allows drafting the release note for the upcoming release, from the
<a href=
"https://github.com/shaarli/Shaarli/releases">Releases
</a> page. This way, the release note can be drafted while contributions are merged to
<code>master
</code>.
</p>
346 <h3 id=
"changelogmd"><code>CHANGELOG.md
</code></h3>
347 <p>This file should contain the same information as the release note draft for the upcoming version.
</p>
349 - add new entries (additions, fixes, etc.)
350 - mark the current version as released by setting its date and link
351 - add a new section for the future unreleased version
</p>
352 <pre><code class=
"bash">$ cd /path/to/shaarli
357 ## vA.B.C - UNRELEASED
360 ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD
364 <h2 id=
"increment-the-version-code-updated-docs-create-and-push-a-signed-tag">Increment the version code, updated docs, create and push a signed tag
</h2>
365 <h3 id=
"generate-documentation">Generate documentation
</h3>
366 <pre><code class=
"bash">$ cd /path/to/shaarli
368 # create a new branch
370 $ git checkout upstream/master -b v0.5
.0
372 # rebuild the HTML documentation from Markdown
377 $ git commit -s -m
"Generate documentation for v0.5
.0"
379 # push the commit on your GitHub fork
380 $ git push origin v0.5
.0
383 <h3 id=
"create-and-merge-a-pull-request">Create and merge a Pull Request
</h3>
384 <p>This one is pretty straightforward ;-)
</p>
385 <h3 id=
"bump-shaarli-version-to-v0x-branch">Bump Shaarli version to v0.x branch
</h3>
386 <pre><code>$ git checkout master
388 $ git pull upstream master
390 # IF the branch doesn't exists
391 $ git checkout -b v0.5
392 # OR if the branch already exists
394 $ git rebase upstream/master
396 # Bump shaarli version from dev to
0.5.0, **without the `v`**
397 $ vim shaarli_version.php
398 $ git add shaarli_version
399 $ git commit -s -m
"Bump Shaarli version to v0.5
.0"
400 $ git push upstream v0.5
403 <h3 id=
"create-and-push-a-signed-tag">Create and push a signed tag
</h3>
404 <pre><code class=
"bash"># update your local copy
407 $ git pull upstream v0.5
409 # create a signed tag
410 $ git tag -s -m
"Release v0.5
.0" v0.5
.0
412 # push it to
"upstream
"
413 $ git push --tags upstream
416 <h3 id=
"verify-a-signed-tag">Verify a signed tag
</h3>
417 <p><a href=
"https://github.com/shaarli/Shaarli/releases/tag/v0.5.0"><code>v0.5
.0</code></a> is the first GPG-signed tag pushed on the Community Shaarli.
</p>
418 <p>Let's have a look at its signature!
</p>
419 <pre><code class=
"bash">$ cd /path/to/shaarli
422 # get the SHA1 reference of the tag
423 $ git show-ref tags/v0.5
.0
424 f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5
.0
426 # verify the tag signature information
427 $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
428 gpg: Signature made Thu
30 Jul
2015 11:
46:
34 CEST using RSA key ID
4100DF6F
429 gpg: Good signature from
"VirtualTam
<virtualtam@flibidi.net
>" [ultimate]
432 <h2 id=
"publish-the-github-release">Publish the GitHub release
</h2>
433 <h3 id=
"update-release-badges">Update release badges
</h3>
434 <p>Update
<code>README.md
</code> so version badges display and point to the newly released Shaarli version(s), in the
<code>master
</code> branch.
</p>
435 <h3 id=
"create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag
</h3>
436 <p>From the previously drafted release:
437 - edit the release notes (if needed)
438 - specify the appropriate Git tag
439 - publish the release
441 <h3 id=
"generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives
</h3>
442 <p>Users with a shared hosting may have:
444 - no possibility to install PHP packages or server extensions
445 - no possibility to run scripts
</p>
446 <p>To ease Shaarli installations, it is possible to generate and upload additional release archives,
447 that will contain Shaarli code plus all required third-party libraries.
</p>
448 <p><strong>From the
<code>v0.5
</code> branch:
</strong></p>
449 <pre><code class=
"bash">$ make release_archive
452 <p>This will create the following archives:
453 -
<code>shaarli-vX.Y.Z-full.tar
</code>
454 -
<code>shaarli-vX.Y.Z-full.zip
</code></p>
455 <p>The archives need to be manually uploaded on the previously created GitHub release.
</p>
456 <h3 id=
"update-stable-and-latest-branches">Update
<code>stable
</code> and
<code>latest
</code> branches
</h3>
457 <pre><code>$ git checkout latest
460 # fix eventual conflicts
462 $ git push upstream latest
463 $ git checkout stable
464 # latest previous major
466 # fix eventual conflicts
468 $ git push upstream stable
475 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
477 <a href=
"../Versioning-and-Branches/" class=
"btn btn-neutral float-right" title=
"Versioning and Branches">Next
<span class=
"icon icon-circle-arrow-right"></span></a>
480 <a href=
"../Plugin-System/" class=
"btn btn-neutral" title=
"Plugin System"><span class=
"icon icon-circle-arrow-left"></span> Previous
</a>
487 <div role=
"contentinfo">
488 <!-- Copyright etc -->
492 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>.
502 <div class=
"rst-versions" role=
"note" style=
"cursor: pointer">
503 <span class=
"rst-current-version" data-toggle=
"rst-current-version">
505 <a href=
"https://github.com/shaarli/Shaarli" class=
"fa fa-github" style=
"float: left; color: #fcfcfc"> GitHub
</a>
508 <span><a href=
"../Plugin-System/" style=
"color: #fcfcfc;">« Previous
</a></span>
511 <span style=
"margin-left: 15px"><a href=
"../Versioning-and-Branches/" style=
"color: #fcfcfc">Next
»</a></span>
515 <script src=
"../js/theme.js"></script>