aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Release-Shaarli.html
diff options
context:
space:
mode:
authorArthur <arthur@hoa.ro>2016-12-12 03:40:09 +0100
committerGitHub <noreply@github.com>2016-12-12 03:40:09 +0100
commitab18fe06d6c03e1a491548d5bb63d231087b7768 (patch)
tree8b6749678ebc21f4d089db796012541b6f44de03 /doc/Release-Shaarli.html
parent75f7adee19f3cced8a2d5eb134e9d6723a69a474 (diff)
parent3cc8c898307ad53507a128db2b11238be2641c32 (diff)
downloadShaarli-ab18fe06d6c03e1a491548d5bb63d231087b7768.tar.gz
Shaarli-ab18fe06d6c03e1a491548d5bb63d231087b7768.tar.zst
Shaarli-ab18fe06d6c03e1a491548d5bb63d231087b7768.zip
Merge pull request #708 from ArthurHoaro/v0.8.1v0.8.1
Bump version to v0.8.1
Diffstat (limited to 'doc/Release-Shaarli.html')
-rw-r--r--doc/Release-Shaarli.html39
1 files changed, 37 insertions, 2 deletions
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html
index cdefd3d6..0d9fa3e1 100644
--- a/doc/Release-Shaarli.html
+++ b/doc/Release-Shaarli.html
@@ -115,9 +115,35 @@ releases</a>.</p>
115<li><code>origin</code> pointing to your GitHub fork</li> 115<li><code>origin</code> pointing to your GitHub fork</li>
116<li><code>upstream</code> pointing to the main Shaarli repository</li> 116<li><code>upstream</code> pointing to the main Shaarli repository</li>
117</ul></li> 117</ul></li>
118<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li> 118<li>maintainer permissions on the main Shaarli repository, to:
119<ul>
120<li>push the signed tag</li>
121<li>create a new release</li>
122</ul></li>
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> 123<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>
120</ul> 124</ul>
125<h2 id="github-release-draft-and-changelog.md">GitHub release draft and <code>CHANGELOG.md</code></h2>
126<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>
127<h3 id="github-release-draft">GitHub release draft</h3>
128<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>
129<h3 id="changelog.md"><code>CHANGELOG.md</code></h3>
130<p>This file should contain the same information as the release note draft for the upcoming version.</p>
131<p>Update it to:</p>
132<ul>
133<li>add new entries (additions, fixes, etc.)</li>
134<li>mark the current version as released by setting its date and link</li>
135<li>add a new section for the future unreleased version</li>
136</ul>
137<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
138
139$ <span class="fu">nano</span> CHANGELOG.md
140
141[<span class="ex">...</span>][](.html)
142<span class="co">## vA.B.C - UNRELEASED</span>
143<span class="ex">TBA</span>
144
145<span class="co">## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)</span>
146[<span class="ex">...</span>][](.html)</code></pre></div>
121<h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2> 147<h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2>
122<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3> 148<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
123<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli 149<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
@@ -165,7 +191,16 @@ $ <span class="fu">git</span> show-ref tags/v0.5.0
165$ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 191$ <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 192<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">&quot;VirtualTam &lt;virtualtam@flibidi.net&gt;&quot;</span> [ultimate][](.html)</code></pre></div> 193<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>
168<h2 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h2> 194<h2 id="publish-the-github-release">Publish the GitHub release</h2>
195<h3 id="create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</h3>
196<p>From the previously drafted release:</p>
197<ul>
198<li>edit the release notes (if needed)</li>
199<li>specify the appropriate Git tag</li>
200<li>publish the release</li>
201<li>profit!</li>
202</ul>
203<h3 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h3>
169<p>Users with a shared hosting may have:</p> 204<p>Users with a shared hosting may have:</p>
170<ul> 205<ul>
171<li>no SSH access</li> 206<li>no SSH access</li>