aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Release-Shaarli.html
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2016-04-14 14:20:23 +0200
committerArthurHoaro <arthur@hoa.ro>2016-04-14 15:18:25 +0200
commit5409ade28c5f0acf99dbadd4d95e6f8efda5d395 (patch)
tree4c8b55010ad02d91b524b0cb8cc02ddf318fcaa2 /doc/Release-Shaarli.html
parent9f400b0dad68b82d65692bd6ab6190f6a787fa89 (diff)
downloadShaarli-5409ade28c5f0acf99dbadd4d95e6f8efda5d395.tar.gz
Shaarli-5409ade28c5f0acf99dbadd4d95e6f8efda5d395.tar.zst
Shaarli-5409ade28c5f0acf99dbadd4d95e6f8efda5d395.zip
Update docs from Wiki
Diffstat (limited to 'doc/Release-Shaarli.html')
-rw-r--r--doc/Release-Shaarli.html171
1 files changed, 171 insertions, 0 deletions
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html
new file mode 100644
index 00000000..69b49478
--- /dev/null
+++ b/doc/Release-Shaarli.html
@@ -0,0 +1,171 @@
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">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > 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>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
67<li><a href="Usage.html">Usage</a>
68<ul>
69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
71<li><a href="Firefox-share.html">Firefox share</a></li>
72<li><a href="RSS-feeds.html">RSS feeds</a></li>
73</ul></li>
74<li>How To
75<ul>
76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
78<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>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
82</ul></li>
83<li><a href="Troubleshooting.html">Troubleshooting</a></li>
84<li><a href="Development.html">Development</a>
85<ul>
86<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
87<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
88<li><a href="Directory-structure.html">Directory structure</a></li>
89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
92<li><a href="Security.html">Security</a></li>
93<li><a href="Static-analysis.html">Static analysis</a></li>
94<li><a href="Theming.html">Theming</a></li>
95<li><a href="Unit-tests.html">Unit tests</a></li>
96</ul></li>
97<li>About
98<ul>
99<li><a href="FAQ.html">FAQ</a></li>
100<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
101<li><a href="TODO.html">TODO</a></li>
102</ul></li>
103</ul>
104</div>
105<h1 id="release-shaarli">Release Shaarli</h1>
106<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 />
107releases</a>.</p>
108<h3 id="prerequisites">Prerequisites</h3>
109<p>This guide assumes that you have:</p>
110<ul>
111<li>a GPG key matching your GitHub authentication credentials
112<ul>
113<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
114</ul></li>
115<li>a GitHub fork of Shaarli</li>
116<li>a local clone of your Shaarli fork, with the following remotes:
117<ul>
118<li><code>origin</code> pointing to your GitHub fork</li>
119<li><code>upstream</code> pointing to the main Shaarli repository</li>
120</ul></li>
121<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li>
122<li><a href="http://pandoc.org/">Pandoc</a> needs to be installed.<a href=".html"></a></li>
123</ul>
124<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
125<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
126
127<span class="co"># create a new branch</span>
128$ <span class="kw">git</span> fetch upstream
129$ <span class="kw">git</span> checkout upstream/master -b v0.5.0
130
131<span class="co"># bump the version number</span>
132$ <span class="kw">vim</span> index.php shaarli_version.php
133
134<span class="co"># rebuild the documentation from the wiki</span>
135$ <span class="kw">make</span> htmldoc
136
137<span class="co"># commit the changes</span>
138$ <span class="kw">git</span> add index.php shaarli_version.php doc
139$ <span class="kw">git</span> commit -s -m <span class="st">&quot;Bump version to v0.5.0&quot;</span>
140
141<span class="co"># push the commit on your GitHub fork</span>
142$ <span class="kw">git</span> push origin v0.5.0</code></pre></div>
143<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
144<p>This one is pretty straightforward ;-)</p>
145<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
146<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
147$ <span class="kw">git</span> checkout master
148$ <span class="kw">git</span> fetch upstream
149$ <span class="kw">git</span> pull upstream master
150
151<span class="co"># create a signed tag</span>
152$ <span class="kw">git</span> tag -s -m <span class="st">&quot;Release v0.5.0&quot;</span> v0.5.0
153
154<span class="co"># push it to &quot;upstream&quot;</span>
155$ <span class="kw">git</span> push --tags upstream</code></pre></div>
156<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
157<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>
158<p>Let's have a look at its signature!</p>
159<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
160$ <span class="kw">git</span> fetch upstream
161
162<span class="co"># get the SHA1 reference of the tag</span>
163$ <span class="kw">git</span> show-ref tags/v0.5.0
164<span class="kw">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0
165
166<span class="co"># verify the tag signature information</span>
167$ <span class="kw">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
168<span class="kw">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
169<span class="kw">gpg</span>: Good signature from <span class="st">&quot;VirtualTam &lt;virtualtam@flibidi.net&gt;&quot;</span> [ultimate][](.html)</code></pre></div>
170</body>
171</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 23:00:27 +0000