forked from sebsauvage/Shaarli
-
Notifications
You must be signed in to change notification settings - Fork 297
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: ArthurHoaro <[email protected]>
- Loading branch information
1 parent
75f7ade
commit 3cc8c89
Showing
12 changed files
with
198 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -115,9 +115,35 @@ <h2 id="prerequisites">Prerequisites</h2> | |
| <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>maintainer permissions on the main Shaarli repository, to: | ||
| <ul> | ||
| <li>push the signed tag</li> | ||
| <li>create a new release</li> | ||
| </ul></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="github-release-draft-and-changelog.md">GitHub release draft and <code>CHANGELOG.md</code></h2> | ||
| <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> | ||
| <h3 id="github-release-draft">GitHub release draft</h3> | ||
| <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> | ||
| <h3 id="changelog.md"><code>CHANGELOG.md</code></h3> | ||
| <p>This file should contain the same information as the release note draft for the upcoming version.</p> | ||
| <p>Update it to:</p> | ||
| <ul> | ||
| <li>add new entries (additions, fixes, etc.)</li> | ||
| <li>mark the current version as released by setting its date and link</li> | ||
| <li>add a new section for the future unreleased version</li> | ||
| </ul> | ||
| <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli | ||
|
|
||
| $ <span class="fu">nano</span> CHANGELOG.md | ||
|
|
||
| [<span class="ex">...</span>][](.html) | ||
| <span class="co">## vA.B.C - UNRELEASED</span> | ||
| <span class="ex">TBA</span> | ||
|
|
||
| <span class="co">## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)</span> | ||
| [<span class="ex">...</span>][](.html)</code></pre></div> | ||
| <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 | ||
|
|
@@ -165,7 +191,16 @@ <h3 id="verify-a-signed-tag">Verify a signed tag</h3> | |
| $ <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">"VirtualTam <[email protected]>"</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> | ||
| <h2 id="publish-the-github-release">Publish the GitHub release</h2> | ||
| <h3 id="create-a-github-release-from-a-git-tag">Create a GitHub release from a Git tag</h3> | ||
| <p>From the previously drafted release:</p> | ||
| <ul> | ||
| <li>edit the release notes (if needed)</li> | ||
| <li>specify the appropriate Git tag</li> | ||
| <li>publish the release</li> | ||
| <li>profit!</li> | ||
| </ul> | ||
| <h3 id="generate-and-upload-all-in-one-release-archives">Generate and upload all-in-one release archives</h3> | ||
| <p>Users with a shared hosting may have:</p> | ||
| <ul> | ||
| <li>no SSH access</li> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,9 +10,39 @@ This guide assumes that you have: | |
| - a local clone of your Shaarli fork, with the following remotes: | ||
| - `origin` pointing to your GitHub fork | ||
| - `upstream` pointing to the main Shaarli repository | ||
| - maintainer permissions on the main Shaarli repository (to push the signed tag) | ||
| - maintainer permissions on the main Shaarli repository, to: | ||
| - push the signed tag | ||
| - create a new release | ||
| - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) | ||
|
|
||
| ## GitHub release draft and `CHANGELOG.md` | ||
| See http://keepachangelog.com/en/0.3.0/ for changelog formatting. | ||
|
|
||
| ### GitHub release draft | ||
| GitHub allows drafting the release note for the upcoming release, from the [Releases](https://github.com/shaarli/Shaarli/releases) page. This way, the release note can be drafted while contributions are merged to `master`.[](.html) | ||
|
|
||
| ### `CHANGELOG.md` | ||
| This file should contain the same information as the release note draft for the upcoming version. | ||
|
|
||
| Update it to: | ||
| - add new entries (additions, fixes, etc.) | ||
| - mark the current version as released by setting its date and link | ||
| - add a new section for the future unreleased version | ||
|
|
||
| ```bash | ||
| $ cd /path/to/shaarli | ||
|
|
||
| $ nano CHANGELOG.md | ||
|
|
||
| [...][](.html) | ||
| ## vA.B.C - UNRELEASED | ||
| TBA | ||
|
|
||
| ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html) | ||
| [...][](.html) | ||
| ``` | ||
|
|
||
|
|
||
| ## Increment the version code, create and push a signed tag | ||
| ### Bump Shaarli's version | ||
| ```bash | ||
|
|
@@ -72,7 +102,15 @@ gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | |
| gpg: Good signature from "VirtualTam <[email protected]>" [ultimate][](.html) | ||
| ``` | ||
|
|
||
| ## Generate and upload all-in-one release archives | ||
| ## Publish the GitHub release | ||
| ### Create a GitHub release from a Git tag | ||
| From the previously drafted release: | ||
| - edit the release notes (if needed) | ||
| - specify the appropriate Git tag | ||
| - publish the release | ||
| - profit! | ||
|
|
||
| ### Generate and upload all-in-one release archives | ||
| Users with a shared hosting may have: | ||
| - no SSH access | ||
| - no possibility to install PHP packages or server extensions | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.