[github/shaarli/Shaarli.git] / doc / Release-Shaarli.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title>Shaarli – Release Shaarli</title>
  <style type="text/css">code{white-space: pre;}</style>
  <style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  </style>
  <link rel="stylesheet" href="github-markdown.css">
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<div id="local-sidebar">
<ul>
<li><a href="Home.html">Home</a></li>
<li>Setup
<ul>
<li><a href="Download-and-Installation.html">Download and Installation</a></li>
<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
<li><a href="Server-requirements.html">Server requirements</a></li>
<li><a href="Server-configuration.html">Server configuration</a></li>
<li><a href="Server-security.html">Server security</a></li>
<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
<li><a href="Plugins.html">Plugins</a></li>
</ul></li>
<li><a href="Docker.html">Docker</a></li>
<li><a href="Usage.html">Usage</a>
<ul>
<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
<li><a href="Firefox-share.html">Firefox share</a></li>
<li><a href="RSS-feeds.html">RSS feeds</a></li>
</ul></li>
<li>How To
<ul>
<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
</ul></li>
<li><a href="Troubleshooting.html">Troubleshooting</a></li>
<li><a href="Development.html">Development</a>
<ul>
<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
<li><a href="Directory-structure.html">Directory structure</a></li>
<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
<li><a href="Plugin-System.html">Plugin System</a></li>
<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
<li><a href="Security.html">Security</a></li>
<li><a href="Static-analysis.html">Static analysis</a></li>
<li><a href="Theming.html">Theming</a></li>
<li><a href="Unit-tests.html">Unit tests</a></li>
</ul></li>
<li>About
<ul>
<li><a href="FAQ.html">FAQ</a></li>
<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
</ul></li>
</ul>
</div>
<h1 id="release-shaarli">Release Shaarli</h1>
<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 [](.html)<br />
releases</a>.</p>
<h2 id="prerequisites">Prerequisites</h2>
<p>This guide assumes that you have:</p>
<ul>
<li>a GPG key matching your GitHub authentication credentials
<ul>
<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
</ul></li>
<li>a GitHub fork of Shaarli</li>
<li>a local clone of your Shaarli fork, with the following remotes:
<ul>
<li><code>origin</code> pointing to your GitHub fork</li>
<li><code>upstream</code> pointing to the main Shaarli repository</li>
</ul></li>
<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li>
<li><a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed<a href=".html"></a></li>
</ul>
<h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2>
<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli

<span class="co"># create a new branch</span>
$ <span class="fu">git</span> fetch upstream
$ <span class="fu">git</span> checkout upstream/master -b v0.5.0

<span class="co"># bump the version number</span>
$ <span class="ex">vim</span> index.php shaarli_version.php

<span class="co"># rebuild the documentation from the wiki</span>
$ <span class="fu">make</span> htmldoc

<span class="co"># commit the changes</span>
$ <span class="fu">git</span> add index.php shaarli_version.php doc
$ <span class="fu">git</span> commit -s -m <span class="st">&quot;Bump version to v0.5.0&quot;</span>

<span class="co"># push the commit on your GitHub fork</span>
$ <span class="fu">git</span> push origin v0.5.0</code></pre></div>
<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
<p>This one is pretty straightforward ;-)</p>
<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
$ <span class="fu">git</span> checkout master
$ <span class="fu">git</span> fetch upstream
$ <span class="fu">git</span> pull upstream master

<span class="co"># create a signed tag</span>
$ <span class="fu">git</span> tag -s -m <span class="st">&quot;Release v0.5.0&quot;</span> v0.5.0

<span class="co"># push it to &quot;upstream&quot;</span>
$ <span class="fu">git</span> push --tags upstream</code></pre></div>
<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
<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.<a href=".html"></a></p>
<p>Let's have a look at its signature!</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
$ <span class="fu">git</span> fetch upstream

<span class="co"># get the SHA1 reference of the tag</span>
$ <span class="fu">git</span> show-ref tags/v0.5.0
<span class="ex">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0

<span class="co"># verify the tag signature information</span>
$ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
<span class="ex">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
<span class="ex">gpg</span>: Good signature from <span class="st">&quot;VirtualTam &lt;virtualtam@flibidi.net&gt;&quot;</span> [ultimate][](.html)</code></pre></div>
<h2 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h2>
<p>Users with a shared hosting may have:</p>
<ul>
<li>no SSH access</li>
<li>no possibility to install PHP packages or server extensions</li>
<li>no possibility to run scripts</li>
</ul>
<p>To ease Shaarli installations, it is possible to generate and upload additional release archives,<br />
that will contain Shaarli code plus all required third-party libraries:</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> release_archive</code></pre></div>
<p>This will create the following archives:</p>
<ul>
<li><code>shaarli-vX.Y.Z-full.tar</code></li>
<li><code>shaarli-vX.Y.Z-full.zip</code></li>
</ul>
<p>The archives need to be manually uploaded on the previously created GitHub release.</p>
</body>
</html>
Commit	Line	Data
5409ade2 A	1	<!DOCTYPE html>
	2	<html>
	3	<head>
	4	<meta charset="utf-8">
	5	<meta name="generator" content="pandoc">
	6	<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
	7	<title>Shaarli – Release Shaarli</title>
	8	<style type="text/css">code{white-space: pre;}</style>
	9	<style type="text/css">
	10	div.sourceCode { overflow-x: auto; }
	11	table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
	12	margin: 0; padding: 0; vertical-align: baseline; border: none; }
	13	table.sourceCode { width: 100%; line-height: 100%; }
	14	td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
	15	td.sourceCode { padding-left: 5px; }
	16	code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
	17	code > span.dt { color: #902000; } /* DataType */
	18	code > span.dv { color: #40a070; } /* DecVal */
	19	code > span.bn { color: #40a070; } /* BaseN */
	20	code > span.fl { color: #40a070; } /* Float */
	21	code > span.ch { color: #4070a0; } /* Char */
	22	code > span.st { color: #4070a0; } /* String */
	23	code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
	24	code > span.ot { color: #007020; } /* Other */
	25	code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
	26	code > span.fu { color: #06287e; } /* Function */
	27	code > span.er { color: #ff0000; font-weight: bold; } /* Error */
	28	code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
	29	code > span.cn { color: #880000; } /* Constant */
	30	code > span.sc { color: #4070a0; } /* SpecialChar */
	31	code > span.vs { color: #4070a0; } /* VerbatimString */
	32	code > span.ss { color: #bb6688; } /* SpecialString */
	33	code > span.im { } /* Import */
	34	code > span.va { color: #19177c; } /* Variable */
	35	code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
	36	code > span.op { color: #666666; } /* Operator */
	37	code > span.bu { } /* BuiltIn */
	38	code > span.ex { } /* Extension */
	39	code > span.pp { color: #bc7a00; } /* Preprocessor */
	40	code > span.at { color: #7d9029; } /* Attribute */
	41	code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
	42	code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
	43	code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
	44	code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
	45	</style>
	46	<link rel="stylesheet" href="github-markdown.css">
	47	<!--[if lt IE 9]>
	48	<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
	49	<![endif]-->
	50	</head>
	51	<body>
	52	<div id="local-sidebar">
	53	<ul>
	54	<li><a href="Home.html">Home</a></li>
fdf88d19	55	<li>Setup
5409ade2	56	<ul>
fdf88d19 A	57	<li><a href="Download-and-Installation.html">Download and Installation</a></li>
fdf88d19 A	58	<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
5409ade2 A	59	<li><a href="Server-requirements.html">Server requirements</a></li>
	60	<li><a href="Server-configuration.html">Server configuration</a></li>
	61	<li><a href="Server-security.html">Server security</a></li>
5409ade2	62	<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea	63	<li><a href="Plugins.html">Plugins</a></li>
5409ade2 A	64	</ul></li>
5409ade2 A	65	<li><a href="Docker.html">Docker</a></li>
5409ade2 A	66	<li><a href="Usage.html">Usage</a>
	67	<ul>
	68	<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
	69	<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
	70	<li><a href="Firefox-share.html">Firefox share</a></li>
	71	<li><a href="RSS-feeds.html">RSS feeds</a></li>
	72	</ul></li>
	73	<li>How To
	74	<ul>
	75	<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
5409ade2 A	76	<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
	77	<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
	78	<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
	79	<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
	80	</ul></li>
	81	<li><a href="Troubleshooting.html">Troubleshooting</a></li>
	82	<li><a href="Development.html">Development</a>
	83	<ul>
	84	<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
	85	<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
	86	<li><a href="Directory-structure.html">Directory structure</a></li>
	87	<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
	88	<li><a href="Plugin-System.html">Plugin System</a></li>
	89	<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
	90	<li><a href="Security.html">Security</a></li>
	91	<li><a href="Static-analysis.html">Static analysis</a></li>
	92	<li><a href="Theming.html">Theming</a></li>
	93	<li><a href="Unit-tests.html">Unit tests</a></li>
	94	</ul></li>
	95	<li>About
	96	<ul>
	97	<li><a href="FAQ.html">FAQ</a></li>
	98	<li><a href="Community-&-Related-software.html">Community & Related software</a></li>
5409ade2 A	99	</ul></li>
	100	</ul>
	101	</div>
	102	<h1 id="release-shaarli">Release Shaarli</h1>
	103	<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 [](.html)<br />
	104	releases</a>.</p>
fdf88d19	105	<h2 id="prerequisites">Prerequisites</h2>
5409ade2 A	106	<p>This guide assumes that you have:</p>
	107	<ul>
	108	<li>a GPG key matching your GitHub authentication credentials
	109	<ul>
	110	<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
	111	</ul></li>
	112	<li>a GitHub fork of Shaarli</li>
	113	<li>a local clone of your Shaarli fork, with the following remotes:
	114	<ul>
	115	<li><code>origin</code> pointing to your GitHub fork</li>
	116	<li><code>upstream</code> pointing to the main Shaarli repository</li>
	117	</ul></li>
	118	<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li>
fdf88d19	119	<li><a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed<a href=".html"></a></li>
5409ade2	120	</ul>
fdf88d19	121	<h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2>
5409ade2	122	<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
fdf88d19	123	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
5409ade2 A	124
5409ade2 A	125	<span class="co"># create a new branch</span>
fdf88d19 A	126	$ <span class="fu">git</span> fetch upstream
fdf88d19 A	127	$ <span class="fu">git</span> checkout upstream/master -b v0.5.0
5409ade2 A	128
5409ade2 A	129	<span class="co"># bump the version number</span>
fdf88d19	130	$ <span class="ex">vim</span> index.php shaarli_version.php
5409ade2 A	131
5409ade2 A	132	<span class="co"># rebuild the documentation from the wiki</span>
fdf88d19	133	$ <span class="fu">make</span> htmldoc
5409ade2 A	134
5409ade2 A	135	<span class="co"># commit the changes</span>
fdf88d19 A	136	$ <span class="fu">git</span> add index.php shaarli_version.php doc
fdf88d19 A	137	$ <span class="fu">git</span> commit -s -m <span class="st">"Bump version to v0.5.0"</span>
5409ade2 A	138
5409ade2 A	139	<span class="co"># push the commit on your GitHub fork</span>
fdf88d19	140	$ <span class="fu">git</span> push origin v0.5.0</code></pre></div>
5409ade2 A	141	<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
	142	<p>This one is pretty straightforward ;-)</p>
	143	<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
	144	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
fdf88d19 A	145	$ <span class="fu">git</span> checkout master
	146	$ <span class="fu">git</span> fetch upstream
	147	$ <span class="fu">git</span> pull upstream master
5409ade2 A	148
5409ade2 A	149	<span class="co"># create a signed tag</span>
fdf88d19	150	$ <span class="fu">git</span> tag -s -m <span class="st">"Release v0.5.0"</span> v0.5.0
5409ade2 A	151
5409ade2 A	152	<span class="co"># push it to "upstream"</span>
fdf88d19	153	$ <span class="fu">git</span> push --tags upstream</code></pre></div>
5409ade2 A	154	<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
	155	<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.<a href=".html"></a></p>
	156	<p>Let's have a look at its signature!</p>
fdf88d19 A	157	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
fdf88d19 A	158	$ <span class="fu">git</span> fetch upstream
5409ade2 A	159
5409ade2 A	160	<span class="co"># get the SHA1 reference of the tag</span>
fdf88d19 A	161	$ <span class="fu">git</span> show-ref tags/v0.5.0
fdf88d19 A	162	<span class="ex">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0
5409ade2 A	163
5409ade2 A	164	<span class="co"># verify the tag signature information</span>
fdf88d19 A	165	$ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
	166	<span class="ex">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
	167	<span class="ex">gpg</span>: Good signature from <span class="st">"VirtualTam <virtualtam@flibidi.net>"</span> [ultimate][](.html)</code></pre></div>
	168	<h2 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h2>
	169	<p>Users with a shared hosting may have:</p>
	170	<ul>
	171	<li>no SSH access</li>
	172	<li>no possibility to install PHP packages or server extensions</li>
	173	<li>no possibility to run scripts</li>
	174	</ul>
	175	<p>To ease Shaarli installations, it is possible to generate and upload additional release archives,<br />
	176	that will contain Shaarli code plus all required third-party libraries:</p>
	177	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> release_archive</code></pre></div>
	178	<p>This will create the following archives:</p>
	179	<ul>
	180	<li><code>shaarli-vX.Y.Z-full.tar</code></li>
	181	<li><code>shaarli-vX.Y.Z-full.zip</code></li>
	182	</ul>
	183	<p>The archives need to be manually uploaded on the previously created GitHub release.</p>
5409ade2 A	184	</body>
5409ade2 A	185	</html>