aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Release-Shaarli.html
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-07-04 21:37:30 +0200
committerGitHub <noreply@github.com>2017-07-04 21:37:30 +0200
commit5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch)
treed5c46525f3c739d9c63de860427e0b3cadd688e5 /doc/Release-Shaarli.html
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
parent8bf94136e10c64496711c8f66a4f58f89c515360 (diff)
downloadShaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.gz
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.zst
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.zip
Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
Diffstat (limited to 'doc/Release-Shaarli.html')
-rw-r--r--doc/Release-Shaarli.html224
1 files changed, 0 insertions, 224 deletions
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html
deleted file mode 100644
index fa690c7c..00000000
--- a/doc/Release-Shaarli.html
+++ /dev/null
@@ -1,224 +0,0 @@
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>Setup
56<ul>
57<li><a href="Download-and-Installation.html">Download and Installation</a></li>
58<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
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>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugins.html">Plugins</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
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<li><a href="REST-API.html">REST API</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="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
78<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
79<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
80<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
81</ul></li>
82<li><a href="Troubleshooting.html">Troubleshooting</a></li>
83<li><a href="Development.html">Development</a>
84<ul>
85<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
86<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
87<li><a href="Directory-structure.html">Directory structure</a></li>
88<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
89<li><a href="Plugin-System.html">Plugin System</a></li>
90<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
91<li><a href="Versioning-and-Branches.html">Versioning and Branches</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</ul></li>
102</ul>
103</div>
104<h1 id="release-shaarli">Release Shaarli</h1>
105<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 />
106releases</a>.</p>
107<h2 id="prerequisites">Prerequisites</h2>
108<p>This guide assumes that you have:</p>
109<ul>
110<li>a GPG key matching your GitHub authentication credentials
111<ul>
112<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
113</ul></li>
114<li>a GitHub fork of Shaarli</li>
115<li>a local clone of your Shaarli fork, with the following remotes:
116<ul>
117<li><code>origin</code> pointing to your GitHub fork</li>
118<li><code>upstream</code> pointing to the main Shaarli repository</li>
119</ul></li>
120<li>maintainer permissions on the main Shaarli repository, to:
121<ul>
122<li>push the signed tag</li>
123<li>create a new release</li>
124</ul></li>
125<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>
126</ul>
127<h2 id="github-release-draft-and-changelog.md">GitHub release draft and <code>CHANGELOG.md</code></h2>
128<p>See <a href="http://keepachangelog.com/en/0.3.0/" class="uri">http://keepachangelog.com/en/0.3.0/</a> for changelog formatting.</p>
129<h3 id="github-release-draft">GitHub release draft</h3>
130<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>.<a href=".html"></a></p>
131<h3 id="changelog.md"><code>CHANGELOG.md</code></h3>
132<p>This file should contain the same information as the release note draft for the upcoming version.</p>
133<p>Update it to:</p>
134<ul>
135<li>add new entries (additions, fixes, etc.)</li>
136<li>mark the current version as released by setting its date and link</li>
137<li>add a new section for the future unreleased version</li>
138</ul>
139<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
140
141$ <span class="fu">nano</span> CHANGELOG.md
142
143[<span class="ex">...</span>][](.html)
144<span class="co">## vA.B.C - UNRELEASED</span>
145<span class="ex">TBA</span>
146
147<span class="co">## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)</span>
148[<span class="ex">...</span>][](.html)</code></pre></div>
149<h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2>
150<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
151<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
152
153<span class="co"># create a new branch</span>
154$ <span class="fu">git</span> fetch upstream
155$ <span class="fu">git</span> checkout upstream/master -b v0.5.0
156
157<span class="co"># bump the version number</span>
158$ <span class="ex">vim</span> index.php shaarli_version.php
159
160<span class="co"># rebuild the documentation from the wiki</span>
161$ <span class="fu">make</span> htmldoc
162
163<span class="co"># commit the changes</span>
164$ <span class="fu">git</span> add index.php shaarli_version.php doc
165$ <span class="fu">git</span> commit -s -m <span class="st">&quot;Bump version to v0.5.0&quot;</span>
166
167<span class="co"># push the commit on your GitHub fork</span>
168$ <span class="fu">git</span> push origin v0.5.0</code></pre></div>
169<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
170<p>This one is pretty straightforward ;-)</p>
171<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
172<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
173$ <span class="fu">git</span> checkout master
174$ <span class="fu">git</span> fetch upstream
175$ <span class="fu">git</span> pull upstream master
176
177<span class="co"># create a signed tag</span>
178$ <span class="fu">git</span> tag -s -m <span class="st">&quot;Release v0.5.0&quot;</span> v0.5.0
179
180<span class="co"># push it to &quot;upstream&quot;</span>
181$ <span class="fu">git</span> push --tags upstream</code></pre></div>
182<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
183<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>
184<p>Let's have a look at its signature!</p>
185<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
186$ <span class="fu">git</span> fetch upstream
187
188<span class="co"># get the SHA1 reference of the tag</span>
189$ <span class="fu">git</span> show-ref tags/v0.5.0
190<span class="ex">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0
191
192<span class="co"># verify the tag signature information</span>
193$ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
194<span class="ex">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
195<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>
196<h2 id="publish-the-github-release">Publish the GitHub release</h2>
197<h3 id="update-release-badges">Update release badges</h3>
198<p>Update <code>README.md</code> so version badges display and point to the newly released Shaarli version(s).</p>
199<h3 id="create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</h3>
200<p>From the previously drafted release:</p>
201<ul>
202<li>edit the release notes (if needed)</li>
203<li>specify the appropriate Git tag</li>
204<li>publish the release</li>
205<li>profit!</li>
206</ul>
207<h3 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h3>
208<p>Users with a shared hosting may have:</p>
209<ul>
210<li>no SSH access</li>
211<li>no possibility to install PHP packages or server extensions</li>
212<li>no possibility to run scripts</li>
213</ul>
214<p>To ease Shaarli installations, it is possible to generate and upload additional release archives,<br />
215that will contain Shaarli code plus all required third-party libraries:</p>
216<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> release_archive</code></pre></div>
217<p>This will create the following archives:</p>
218<ul>
219<li><code>shaarli-vX.Y.Z-full.tar</code></li>
220<li><code>shaarli-vX.Y.Z-full.zip</code></li>
221</ul>
222<p>The archives need to be manually uploaded on the previously created GitHub release.</p>
223</body>
224</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-08 09:09:01 +0000