]>
Commit | Line | Data |
---|---|---|
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 | ||
5 | ### Prerequisites | |
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) | |
14 | - [Pandoc](http://pandoc.org/) needs to be installed.[](.html) | |
15 | ||
16 | ### Bump Shaarli's version | |
17 | ```bash | |
18 | $ cd /path/to/shaarli | |
19 | ||
20 | # create a new branch | |
21 | $ git fetch upstream | |
22 | $ git checkout upstream/master -b v0.5.0 | |
23 | ||
24 | # bump the version number | |
25 | $ vim index.php shaarli_version.php | |
26 | ||
27 | # rebuild the documentation from the wiki | |
28 | $ make htmldoc | |
29 | ||
30 | # commit the changes | |
31 | $ git add index.php shaarli_version.php doc | |
32 | $ git commit -s -m "Bump version to v0.5.0" | |
33 | ||
34 | # push the commit on your GitHub fork | |
35 | $ git push origin v0.5.0 | |
36 | ``` | |
37 | ||
38 | ### Create and merge a Pull Request | |
39 | This one is pretty straightforward ;-) | |
40 | ||
41 | ### Create and push a signed tag | |
42 | ```bash | |
43 | # update your local copy | |
44 | $ git checkout master | |
45 | $ git fetch upstream | |
46 | $ git pull upstream master | |
47 | ||
48 | # create a signed tag | |
49 | $ git tag -s -m "Release v0.5.0" v0.5.0 | |
50 | ||
51 | # push it to "upstream" | |
52 | $ git push --tags upstream | |
53 | ``` | |
54 | ||
55 | ### Verify a signed tag | |
56 | [`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) | |
57 | ||
58 | Let's have a look at its signature! | |
59 | ||
60 | ```bash | |
61 | $ cd /path/to/shaarli | |
62 | $ git fetch upstream | |
63 | ||
64 | # get the SHA1 reference of the tag | |
65 | $ git show-ref tags/v0.5.0 | |
66 | f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0 | |
67 | ||
68 | # verify the tag signature information | |
69 | $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 | |
70 | 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 | ``` |