1 See [Git - Maintaining a project - Tagging your
2 releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases).
5 This guide assumes that you have:
6 - a GPG key matching your GitHub authentication credentials
7 - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig`
8 - a GitHub fork of Shaarli
9 - a local clone of your Shaarli fork, with the following remotes:
10 - `origin` pointing to your GitHub fork
11 - `upstream` pointing to the main Shaarli repository
12 - maintainer permissions on the main Shaarli repository, to:
14 - create a new release
15 - [Composer](https://getcomposer.org/) needs to be installed
16 - The [venv](https://docs.python.org/3/library/venv.html) Python 3 module needs to be installed for HTML documentation generation.
18 ## GitHub release draft and `CHANGELOG.md`
19 See http://keepachangelog.com/en/0.3.0/ for changelog formatting.
21 ### GitHub release draft
22 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`.
25 This file should contain the same information as the release note draft for the upcoming version.
28 - add new entries (additions, fixes, etc.)
29 - mark the current version as released by setting its date and link
30 - add a new section for the future unreleased version
38 ## vA.B.C - UNRELEASED
41 ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD
46 ## Increment the version code, updated docs, create and push a signed tag
47 ### Generate documentation
53 $ git checkout upstream/master -b v0.5.0
55 # rebuild the HTML documentation from Markdown
60 $ git commit -s -m "Generate documentation for v0.5.0"
62 # push the commit on your GitHub fork
63 $ git push origin v0.5.0
66 ### Create and merge a Pull Request
67 This one is pretty straightforward ;-)
69 ### Bump Shaarli version to v0.x branch
74 $ git pull upstream master
76 # IF the branch doesn't exists
77 $ git checkout -b v0.5
78 # OR if the branch already exists
80 $ git rebase upstream/master
82 # Bump shaarli version from dev to 0.5.0, **without the `v`**
83 $ vim shaarli_version.php
84 $ git add shaarli_version
85 $ git commit -s -m "Bump Shaarli version to v0.5.0"
86 $ git push upstream v0.5
89 ### Create and push a signed tag
91 # update your local copy
94 $ git pull upstream v0.5
97 $ git tag -s -m "Release v0.5.0" v0.5.0
99 # push it to "upstream"
100 $ git push --tags upstream
103 ### Verify a signed tag
104 [`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.
106 Let's have a look at its signature!
109 $ cd /path/to/shaarli
112 # get the SHA1 reference of the tag
113 $ git show-ref tags/v0.5.0
114 f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
116 # verify the tag signature information
117 $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
118 gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
119 gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate]
122 ## Publish the GitHub release
123 ### Update release badges
124 Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch.
126 ### Create a GitHub release from a Git tag
127 From the previously drafted release:
128 - edit the release notes (if needed)
129 - specify the appropriate Git tag
130 - publish the release
133 ### Generate and upload all-in-one release archives
134 Users with a shared hosting may have:
136 - no possibility to install PHP packages or server extensions
137 - no possibility to run scripts
139 To ease Shaarli installations, it is possible to generate and upload additional release archives,
140 that will contain Shaarli code plus all required third-party libraries.
142 **From the `v0.5` branch:**
145 $ make release_archive
148 This will create the following archives:
149 - `shaarli-vX.Y.Z-full.tar`
150 - `shaarli-vX.Y.Z-full.zip`
152 The archives need to be manually uploaded on the previously created GitHub release.
154 ### Update `stable` and `latest` branches
157 $ git checkout latest
160 # fix eventual conflicts
162 $ git push upstream latest
163 $ git checkout stable
164 # latest previous major
166 # fix eventual conflicts
168 $ git push upstream stable