diff options
| author | Arthur <arthur@hoa.ro> | 2016-10-12 12:39:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-12 12:39:52 +0200 |
| commit | 24cfb960cfdd88255333bfb2a08d586916b460ae (patch) | |
| tree | f204fb8ba9e589d4e063c57da01716c487b6e891 /doc/Release-Shaarli.md | |
| parent | dc8e03bfc415d3771a45ccd324078a48b7466cbe (diff) | |
| parent | fdf88d194874a533cf3a8de3d317d70018aa8a62 (diff) | |
| download | Shaarli-24cfb960cfdd88255333bfb2a08d586916b460ae.tar.gz Shaarli-24cfb960cfdd88255333bfb2a08d586916b460ae.tar.zst Shaarli-24cfb960cfdd88255333bfb2a08d586916b460ae.zip | |
Merge pull request #656 from ArthurHoaro/v0.8.0v0.8.0
Bump version to v0.8.0
Diffstat (limited to 'doc/Release-Shaarli.md')
| -rw-r--r-- | doc/Release-Shaarli.md | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/Release-Shaarli.md b/doc/Release-Shaarli.md index d5044fe9..5cbcd79a 100644 --- a/doc/Release-Shaarli.md +++ b/doc/Release-Shaarli.md | |||
| @@ -2,7 +2,7 @@ | |||
| 2 | See [Git - Maintaining a project - Tagging your [](.html) | 2 | See [Git - Maintaining a project - Tagging your [](.html) |
| 3 | releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases). | 3 | releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases). |
| 4 | 4 | ||
| 5 | ### Prerequisites | 5 | ## Prerequisites |
| 6 | This guide assumes that you have: | 6 | This guide assumes that you have: |
| 7 | - a GPG key matching your GitHub authentication credentials | 7 | - a GPG key matching your GitHub authentication credentials |
| 8 | - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig` | 8 | - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig` |
| @@ -11,8 +11,9 @@ This guide assumes that you have: | |||
| 11 | - `origin` pointing to your GitHub fork | 11 | - `origin` pointing to your GitHub fork |
| 12 | - `upstream` pointing to the main Shaarli repository | 12 | - `upstream` pointing to the main Shaarli repository |
| 13 | - maintainer permissions on the main Shaarli repository (to push the signed tag) | 13 | - maintainer permissions on the main Shaarli repository (to push the signed tag) |
| 14 | - [Pandoc](http://pandoc.org/) needs to be installed.[](.html) | 14 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) |
| 15 | 15 | ||
| 16 | ## Increment the version code, create and push a signed tag | ||
| 16 | ### Bump Shaarli's version | 17 | ### Bump Shaarli's version |
| 17 | ```bash | 18 | ```bash |
| 18 | $ cd /path/to/shaarli | 19 | $ cd /path/to/shaarli |
| @@ -70,3 +71,22 @@ $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | |||
| 70 | gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | 71 | gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F |
| 71 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) | 72 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) |
| 72 | ``` | 73 | ``` |
| 74 | |||
| 75 | ## Generate and upload all-in-one release archives | ||
| 76 | Users with a shared hosting may have: | ||
| 77 | - no SSH access | ||
| 78 | - no possibility to install PHP packages or server extensions | ||
| 79 | - no possibility to run scripts | ||
| 80 | |||
| 81 | To ease Shaarli installations, it is possible to generate and upload additional release archives, | ||
| 82 | that will contain Shaarli code plus all required third-party libraries: | ||
| 83 | |||
| 84 | ```bash | ||
| 85 | $ make release_archive | ||
| 86 | ``` | ||
| 87 | |||
| 88 | This will create the following archives: | ||
| 89 | - `shaarli-vX.Y.Z-full.tar` | ||
| 90 | - `shaarli-vX.Y.Z-full.zip` | ||
| 91 | |||
| 92 | The archives need to be manually uploaded on the previously created GitHub release. | ||