diff options
Diffstat (limited to 'doc/Release-Shaarli.html')
-rw-r--r-- | doc/Release-Shaarli.html | 106 |
1 files changed, 78 insertions, 28 deletions
diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html index cfaa663b..0d9fa3e1 100644 --- a/doc/Release-Shaarli.html +++ b/doc/Release-Shaarli.html | |||
@@ -52,13 +52,13 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
52 | <div id="local-sidebar"> | 52 | <div id="local-sidebar"> |
53 | <ul> | 53 | <ul> |
54 | <li><a href="Home.html">Home</a></li> | 54 | <li><a href="Home.html">Home</a></li> |
55 | <li>Installation | 55 | <li>Setup |
56 | <ul> | 56 | <ul> |
57 | <li><a href="Download.html">Download</a></li> | 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> | ||
58 | <li><a href="Server-requirements.html">Server requirements</a></li> | 59 | <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-configuration.html">Server configuration</a></li> |
60 | <li><a href="Server-security.html">Server security</a></li> | 61 | <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> | 62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> |
63 | <li><a href="Plugins.html">Plugins</a></li> | 63 | <li><a href="Plugins.html">Plugins</a></li> |
64 | </ul></li> | 64 | </ul></li> |
@@ -73,7 +73,6 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
73 | <li>How To | 73 | <li>How To |
74 | <ul> | 74 | <ul> |
75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | 75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> |
76 | <li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</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> | 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> |
78 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | 77 | <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> | 78 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> |
@@ -97,14 +96,13 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
97 | <ul> | 96 | <ul> |
98 | <li><a href="FAQ.html">FAQ</a></li> | 97 | <li><a href="FAQ.html">FAQ</a></li> |
99 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | 98 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> |
100 | <li><a href="TODO.html">TODO</a></li> | ||
101 | </ul></li> | 99 | </ul></li> |
102 | </ul> | 100 | </ul> |
103 | </div> | 101 | </div> |
104 | <h1 id="release-shaarli">Release Shaarli</h1> | 102 | <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 /> | 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 /> |
106 | releases</a>.</p> | 104 | releases</a>.</p> |
107 | <h3 id="prerequisites">Prerequisites</h3> | 105 | <h2 id="prerequisites">Prerequisites</h2> |
108 | <p>This guide assumes that you have:</p> | 106 | <p>This guide assumes that you have:</p> |
109 | <ul> | 107 | <ul> |
110 | <li>a GPG key matching your GitHub authentication credentials | 108 | <li>a GPG key matching your GitHub authentication credentials |
@@ -117,54 +115,106 @@ releases</a>.</p> | |||
117 | <li><code>origin</code> pointing to your GitHub fork</li> | 115 | <li><code>origin</code> pointing to your GitHub fork</li> |
118 | <li><code>upstream</code> pointing to the main Shaarli repository</li> | 116 | <li><code>upstream</code> pointing to the main Shaarli repository</li> |
119 | </ul></li> | 117 | </ul></li> |
120 | <li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li> | 118 | <li>maintainer permissions on the main Shaarli repository, to: |
121 | <li><a href="http://pandoc.org/">Pandoc</a> needs to be installed.<a href=".html"></a></li> | 119 | <ul> |
120 | <li>push the signed tag</li> | ||
121 | <li>create a new release</li> | ||
122 | </ul></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> | ||
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> | ||
122 | </ul> | 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> | ||
147 | <h2 id="increment-the-version-code-create-and-push-a-signed-tag">Increment the version code, create and push a signed tag</h2> | ||
123 | <h3 id="bump-shaarlis-version">Bump Shaarli's version</h3> | 148 | <h3 id="bump-shaarlis-version">Bump Shaarli's version</h3> |
124 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">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 |
125 | 150 | ||
126 | <span class="co"># create a new branch</span> | 151 | <span class="co"># create a new branch</span> |
127 | $ <span class="kw">git</span> fetch upstream | 152 | $ <span class="fu">git</span> fetch upstream |
128 | $ <span class="kw">git</span> checkout upstream/master -b v0.5.0 | 153 | $ <span class="fu">git</span> checkout upstream/master -b v0.5.0 |
129 | 154 | ||
130 | <span class="co"># bump the version number</span> | 155 | <span class="co"># bump the version number</span> |
131 | $ <span class="kw">vim</span> index.php shaarli_version.php | 156 | $ <span class="ex">vim</span> index.php shaarli_version.php |
132 | 157 | ||
133 | <span class="co"># rebuild the documentation from the wiki</span> | 158 | <span class="co"># rebuild the documentation from the wiki</span> |
134 | $ <span class="kw">make</span> htmldoc | 159 | $ <span class="fu">make</span> htmldoc |
135 | 160 | ||
136 | <span class="co"># commit the changes</span> | 161 | <span class="co"># commit the changes</span> |
137 | $ <span class="kw">git</span> add index.php shaarli_version.php doc | 162 | $ <span class="fu">git</span> add index.php shaarli_version.php doc |
138 | $ <span class="kw">git</span> commit -s -m <span class="st">"Bump version to v0.5.0"</span> | 163 | $ <span class="fu">git</span> commit -s -m <span class="st">"Bump version to v0.5.0"</span> |
139 | 164 | ||
140 | <span class="co"># push the commit on your GitHub fork</span> | 165 | <span class="co"># push the commit on your GitHub fork</span> |
141 | $ <span class="kw">git</span> push origin v0.5.0</code></pre></div> | 166 | $ <span class="fu">git</span> push origin v0.5.0</code></pre></div> |
142 | <h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3> | 167 | <h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3> |
143 | <p>This one is pretty straightforward ;-)</p> | 168 | <p>This one is pretty straightforward ;-)</p> |
144 | <h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3> | 169 | <h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3> |
145 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span> | 170 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span> |
146 | $ <span class="kw">git</span> checkout master | 171 | $ <span class="fu">git</span> checkout master |
147 | $ <span class="kw">git</span> fetch upstream | 172 | $ <span class="fu">git</span> fetch upstream |
148 | $ <span class="kw">git</span> pull upstream master | 173 | $ <span class="fu">git</span> pull upstream master |
149 | 174 | ||
150 | <span class="co"># create a signed tag</span> | 175 | <span class="co"># create a signed tag</span> |
151 | $ <span class="kw">git</span> tag -s -m <span class="st">"Release v0.5.0"</span> v0.5.0 | 176 | $ <span class="fu">git</span> tag -s -m <span class="st">"Release v0.5.0"</span> v0.5.0 |
152 | 177 | ||
153 | <span class="co"># push it to "upstream"</span> | 178 | <span class="co"># push it to "upstream"</span> |
154 | $ <span class="kw">git</span> push --tags upstream</code></pre></div> | 179 | $ <span class="fu">git</span> push --tags upstream</code></pre></div> |
155 | <h3 id="verify-a-signed-tag">Verify a signed tag</h3> | 180 | <h3 id="verify-a-signed-tag">Verify a signed tag</h3> |
156 | <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> | 181 | <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> |
157 | <p>Let's have a look at its signature!</p> | 182 | <p>Let's have a look at its signature!</p> |
158 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli | 183 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli |
159 | $ <span class="kw">git</span> fetch upstream | 184 | $ <span class="fu">git</span> fetch upstream |
160 | 185 | ||
161 | <span class="co"># get the SHA1 reference of the tag</span> | 186 | <span class="co"># get the SHA1 reference of the tag</span> |
162 | $ <span class="kw">git</span> show-ref tags/v0.5.0 | 187 | $ <span class="fu">git</span> show-ref tags/v0.5.0 |
163 | <span class="kw">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0 | 188 | <span class="ex">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0 |
164 | 189 | ||
165 | <span class="co"># verify the tag signature information</span> | 190 | <span class="co"># verify the tag signature information</span> |
166 | $ <span class="kw">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | 191 | $ <span class="fu">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 |
167 | <span class="kw">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 |
168 | <span class="kw">gpg</span>: Good signature from <span class="st">"VirtualTam <virtualtam@flibidi.net>"</span> [ultimate][](.html)</code></pre></div> | 193 | <span class="ex">gpg</span>: Good signature from <span class="st">"VirtualTam <virtualtam@flibidi.net>"</span> [ultimate][](.html)</code></pre></div> |
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> | ||
204 | <p>Users with a shared hosting may have:</p> | ||
205 | <ul> | ||
206 | <li>no SSH access</li> | ||
207 | <li>no possibility to install PHP packages or server extensions</li> | ||
208 | <li>no possibility to run scripts</li> | ||
209 | </ul> | ||
210 | <p>To ease Shaarli installations, it is possible to generate and upload additional release archives,<br /> | ||
211 | that will contain Shaarli code plus all required third-party libraries:</p> | ||
212 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> release_archive</code></pre></div> | ||
213 | <p>This will create the following archives:</p> | ||
214 | <ul> | ||
215 | <li><code>shaarli-vX.Y.Z-full.tar</code></li> | ||
216 | <li><code>shaarli-vX.Y.Z-full.zip</code></li> | ||
217 | </ul> | ||
218 | <p>The archives need to be manually uploaded on the previously created GitHub release.</p> | ||
169 | </body> | 219 | </body> |
170 | </html> | 220 | </html> |