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:
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:
15 - create a new release
16 - [Composer](https://getcomposer.org/) needs to be installed
17 - The [venv](https://docs.python.org/3/library/venv.html) Python 3 module needs to be installed for HTML documentation generation.
19 ## GitHub release draft and `CHANGELOG.md`
20 See http://keepachangelog.com/en/0.3.0/ for changelog formatting.
22 ### GitHub release draft
23 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`.
26 This file should contain the same information as the release note draft for the upcoming version.
30 - add new entries (additions, fixes, etc.)
31 - mark the current version as released by setting its date and link
32 - add a new section for the future unreleased version
40 ## vA.B.C - UNRELEASED
43 ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD
48 ## Increment the version code, update docs, create and push a signed tag
49 ### Update the list of Git contributors
52 $ git commit -s -m "Update AUTHORS"
55 ### Create and merge a Pull Request
56 This one is pretty straightforward ;-)
58 ### Bump Shaarli version to v0.x branch
63 $ git pull upstream master
65 # IF the branch doesn't exists
66 $ git checkout -b v0.5
67 # OR if the branch already exists
69 $ git rebase upstream/master
71 # Bump shaarli version from dev to 0.5.0, **without the `v`**
72 $ vim shaarli_version.php
73 $ git add shaarli_version
74 $ git commit -s -m "Bump Shaarli version to v0.5.0"
75 $ git push upstream v0.5
78 ### Create and push a signed tag
80 # update your local copy
83 $ git pull upstream v0.5
86 $ git tag -s -m "Release v0.5.0" v0.5.0
88 # push it to "upstream"
89 $ git push --tags upstream
92 ### Verify a signed tag
93 [`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.
95 Let's have a look at its signature!
101 # get the SHA1 reference of the tag
102 $ git show-ref tags/v0.5.0
103 f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
105 # verify the tag signature information
106 $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
107 gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
108 gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate]
111 ## Publish the GitHub release
112 ### Update release badges
113 Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch.
115 ### Create a GitHub release from a Git tag
116 From the previously drafted release:
118 - edit the release notes (if needed)
119 - specify the appropriate Git tag
120 - publish the release
123 ### Generate and upload all-in-one release archives
124 Users with a shared hosting may have:
127 - no possibility to install PHP packages or server extensions
128 - no possibility to run scripts
130 To ease Shaarli installations, it is possible to generate and upload additional release archives,
131 that will contain Shaarli code plus all required third-party libraries.
133 **From the `v0.5` branch:**
136 $ make release_archive
139 This will create the following archives:
141 - `shaarli-vX.Y.Z-full.tar`
142 - `shaarli-vX.Y.Z-full.zip`
144 The archives need to be manually uploaded on the previously created GitHub release.
146 ### Update `stable` and `latest` branches
149 $ git checkout latest
152 # fix eventual conflicts
154 $ git push upstream latest
155 $ git checkout stable
156 # latest previous major
158 # fix eventual conflicts
160 $ git push upstream stable