]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - doc/md/Release-Shaarli.md
Fix broken css/js files on individual shaare pages
[github/shaarli/Shaarli.git] / doc / md / Release-Shaarli.md
CommitLineData
53ed6d7d 1See [Git - Maintaining a project - Tagging your
5409ade2
A
2releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases).
3
fdf88d19 4## Prerequisites
5409ade2 5This guide assumes that you have:
43ad7c8e 6
5409ade2
A
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
3cc8c898
A
13- maintainer permissions on the main Shaarli repository, to:
14 - push the signed tag
15 - create a new release
081a7348 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.
5409ade2 18
3cc8c898
A
19## GitHub release draft and `CHANGELOG.md`
20See http://keepachangelog.com/en/0.3.0/ for changelog formatting.
21
22### GitHub release draft
53ed6d7d 23GitHub 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`.
3cc8c898
A
24
25### `CHANGELOG.md`
26This file should contain the same information as the release note draft for the upcoming version.
27
28Update it to:
92ccaea4 29
3cc8c898
A
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
33
34```bash
35$ cd /path/to/shaarli
36
37$ nano CHANGELOG.md
38
53ed6d7d 39[...]
3cc8c898
A
40## vA.B.C - UNRELEASED
41TBA
42
53ed6d7d 43## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD
44[...]
3cc8c898
A
45```
46
47
43ad7c8e 48## Increment the version code, update docs, create and push a signed tag
dc37a482
V
49### Update the list of Git contributors
50```bash
51$ make authors
52$ git commit -s -m "Update AUTHORS"
53```
54
5409ade2
A
55### Create and merge a Pull Request
56This one is pretty straightforward ;-)
57
53ed6d7d 58### Bump Shaarli version to v0.x branch
59
23daed64 60```bash
53ed6d7d 61$ git checkout master
62$ git fetch upstream
63$ git pull upstream master
64
65# IF the branch doesn't exists
66$ git checkout -b v0.5
67# OR if the branch already exists
68$ git checkout v0.5
69$ git rebase upstream/master
70
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
76```
77
5409ade2
A
78### Create and push a signed tag
79```bash
80# update your local copy
53ed6d7d 81$ git checkout v0.5
5409ade2 82$ git fetch upstream
53ed6d7d 83$ git pull upstream v0.5
5409ade2
A
84
85# create a signed tag
86$ git tag -s -m "Release v0.5.0" v0.5.0
87
88# push it to "upstream"
89$ git push --tags upstream
90```
91
92### Verify a signed tag
53ed6d7d 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.
5409ade2
A
94
95Let's have a look at its signature!
96
97```bash
98$ cd /path/to/shaarli
99$ git fetch upstream
100
101# get the SHA1 reference of the tag
102$ git show-ref tags/v0.5.0
103f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
104
105# verify the tag signature information
106$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
107gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
53ed6d7d 108gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate]
5409ade2 109```
fdf88d19 110
3cc8c898 111## Publish the GitHub release
b230bf20 112### Update release badges
53ed6d7d 113Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch.
b230bf20 114
3cc8c898
A
115### Create a GitHub release from a Git tag
116From the previously drafted release:
43ad7c8e 117
3cc8c898
A
118- edit the release notes (if needed)
119- specify the appropriate Git tag
120- publish the release
121- profit!
122
123### Generate and upload all-in-one release archives
fdf88d19 124Users with a shared hosting may have:
43ad7c8e 125
fdf88d19
A
126- no SSH access
127- no possibility to install PHP packages or server extensions
128- no possibility to run scripts
129
130To ease Shaarli installations, it is possible to generate and upload additional release archives,
53ed6d7d 131that will contain Shaarli code plus all required third-party libraries.
132
133**From the `v0.5` branch:**
fdf88d19
A
134
135```bash
136$ make release_archive
137```
138
139This will create the following archives:
43ad7c8e 140
fdf88d19
A
141- `shaarli-vX.Y.Z-full.tar`
142- `shaarli-vX.Y.Z-full.zip`
143
144The archives need to be manually uploaded on the previously created GitHub release.
53ed6d7d 145
146### Update `stable` and `latest` branches
147
148```
149$ git checkout latest
150# latest release
151$ git merge v0.5.0
152# fix eventual conflicts
153$ make test
154$ git push upstream latest
155$ git checkout stable
156# latest previous major
157$ git merge v0.4.5
158# fix eventual conflicts
159$ make test
160$ git push upstream stable
161```