aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Release-Shaarli.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Release-Shaarli.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
Diffstat (limited to 'doc/md/Release-Shaarli.md')
-rw-r--r--doc/md/Release-Shaarli.md168
1 files changed, 168 insertions, 0 deletions
diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md
new file mode 100644
index 00000000..cce5e209
--- /dev/null
+++ b/doc/md/Release-Shaarli.md
@@ -0,0 +1,168 @@
1See [Git - Maintaining a project - Tagging your
2releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases).
3
4## Prerequisites
5This 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:
13 - push the signed tag
14 - create a new release
15- [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed
16
17## GitHub release draft and `CHANGELOG.md`
18See http://keepachangelog.com/en/0.3.0/ for changelog formatting.
19
20### GitHub release draft
21GitHub 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`.
22
23### `CHANGELOG.md`
24This file should contain the same information as the release note draft for the upcoming version.
25
26Update it to:
27- add new entries (additions, fixes, etc.)
28- mark the current version as released by setting its date and link
29- add a new section for the future unreleased version
30
31```bash
32$ cd /path/to/shaarli
33
34$ nano CHANGELOG.md
35
36[...]
37## vA.B.C - UNRELEASED
38TBA
39
40## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD
41[...]
42```
43
44
45## Increment the version code, updated docs, create and push a signed tag
46### Generate documentation
47```bash
48$ cd /path/to/shaarli
49
50# create a new branch
51$ git fetch upstream
52$ git checkout upstream/master -b v0.5.0
53
54# rebuild the documentation from the wiki
55$ make htmldoc
56
57# commit the changes
58$ git add doc
59$ git commit -s -m "Generate documentation for v0.5.0"
60
61# push the commit on your GitHub fork
62$ git push origin v0.5.0
63```
64
65### Create and merge a Pull Request
66This one is pretty straightforward ;-)
67
68### Bump Shaarli version to v0.x branch
69
70```
71$ git checkout master
72$ git fetch upstream
73$ git pull upstream master
74
75# IF the branch doesn't exists
76$ git checkout -b v0.5
77# OR if the branch already exists
78$ git checkout v0.5
79$ git rebase upstream/master
80
81# Bump shaarli version from dev to 0.5.0, **without the `v`**
82$ vim shaarli_version.php
83$ git add shaarli_version
84$ git commit -s -m "Bump Shaarli version to v0.5.0"
85$ git push upstream v0.5
86```
87
88### Create and push a signed tag
89```bash
90# update your local copy
91$ git checkout v0.5
92$ git fetch upstream
93$ git pull upstream v0.5
94
95# create a signed tag
96$ git tag -s -m "Release v0.5.0" v0.5.0
97
98# push it to "upstream"
99$ git push --tags upstream
100```
101
102### Verify a signed tag
103[`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli.
104
105Let's have a look at its signature!
106
107```bash
108$ cd /path/to/shaarli
109$ git fetch upstream
110
111# get the SHA1 reference of the tag
112$ git show-ref tags/v0.5.0
113f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
114
115# verify the tag signature information
116$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
117gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
118gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate]
119```
120
121## Publish the GitHub release
122### Update release badges
123Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch.
124
125### Create a GitHub release from a Git tag
126From the previously drafted release:
127- edit the release notes (if needed)
128- specify the appropriate Git tag
129- publish the release
130- profit!
131
132### Generate and upload all-in-one release archives
133Users with a shared hosting may have:
134- no SSH access
135- no possibility to install PHP packages or server extensions
136- no possibility to run scripts
137
138To ease Shaarli installations, it is possible to generate and upload additional release archives,
139that will contain Shaarli code plus all required third-party libraries.
140
141**From the `v0.5` branch:**
142
143```bash
144$ make release_archive
145```
146
147This will create the following archives:
148- `shaarli-vX.Y.Z-full.tar`
149- `shaarli-vX.Y.Z-full.zip`
150
151The archives need to be manually uploaded on the previously created GitHub release.
152
153### Update `stable` and `latest` branches
154
155```
156$ git checkout latest
157# latest release
158$ git merge v0.5.0
159# fix eventual conflicts
160$ make test
161$ git push upstream latest
162$ git checkout stable
163# latest previous major
164$ git merge v0.4.5
165# fix eventual conflicts
166$ make test
167$ git push upstream stable
168```