]>
Commit | Line | Data |
---|---|---|
5409ade2 A |
1 | #Release Shaarli |
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). | |
4 | ||
fdf88d19 | 5 | ## Prerequisites |
5409ade2 A |
6 | This guide assumes that you have: |
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` | |
9 | - a GitHub fork of Shaarli | |
10 | - a local clone of your Shaarli fork, with the following remotes: | |
11 | - `origin` pointing to your GitHub fork | |
12 | - `upstream` pointing to the main Shaarli repository | |
13 | - maintainer permissions on the main Shaarli repository (to push the signed tag) | |
fdf88d19 | 14 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) |
5409ade2 | 15 | |
fdf88d19 | 16 | ## Increment the version code, create and push a signed tag |
5409ade2 A |
17 | ### Bump Shaarli's version |
18 | ```bash | |
19 | $ cd /path/to/shaarli | |
20 | ||
21 | # create a new branch | |
22 | $ git fetch upstream | |
23 | $ git checkout upstream/master -b v0.5.0 | |
24 | ||
25 | # bump the version number | |
26 | $ vim index.php shaarli_version.php | |
27 | ||
28 | # rebuild the documentation from the wiki | |
29 | $ make htmldoc | |
30 | ||
31 | # commit the changes | |
32 | $ git add index.php shaarli_version.php doc | |
33 | $ git commit -s -m "Bump version to v0.5.0" | |
34 | ||
35 | # push the commit on your GitHub fork | |
36 | $ git push origin v0.5.0 | |
37 | ``` | |
38 | ||
39 | ### Create and merge a Pull Request | |
40 | This one is pretty straightforward ;-) | |
41 | ||
42 | ### Create and push a signed tag | |
43 | ```bash | |
44 | # update your local copy | |
45 | $ git checkout master | |
46 | $ git fetch upstream | |
47 | $ git pull upstream master | |
48 | ||
49 | # create a signed tag | |
50 | $ git tag -s -m "Release v0.5.0" v0.5.0 | |
51 | ||
52 | # push it to "upstream" | |
53 | $ git push --tags upstream | |
54 | ``` | |
55 | ||
56 | ### Verify a signed tag | |
57 | [`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.[](.html) | |
58 | ||
59 | Let's have a look at its signature! | |
60 | ||
61 | ```bash | |
62 | $ cd /path/to/shaarli | |
63 | $ git fetch upstream | |
64 | ||
65 | # get the SHA1 reference of the tag | |
66 | $ git show-ref tags/v0.5.0 | |
67 | f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0 | |
68 | ||
69 | # verify the tag signature information | |
70 | $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | |
71 | gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | |
72 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) | |
73 | ``` | |
fdf88d19 A |
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. |