aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Release-Shaarli.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam+github@flibidi.net>2017-08-06 16:15:32 +0200
committerGitHub <noreply@github.com>2017-08-06 16:15:32 +0200
commitc7fcea1347e81072c5b77c1b3c2c6fb13f02c16f (patch)
tree03e4d7bbdcfebdb704266caf4b5c0d87e90c02ce /doc/md/Release-Shaarli.md
parent4758c18164f8168be0b3e422c4af86827c913390 (diff)
parentf320efd689f17737ccbdef46cdc430d9e637b807 (diff)
downloadShaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.gz
Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.zst
Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.zip
Merge pull request #917 from virtualtam/documentation/fixes+improvements
Documentation fixes, improvements and additions
Diffstat (limited to 'doc/md/Release-Shaarli.md')
-rw-r--r--doc/md/Release-Shaarli.md27
1 files changed, 6 insertions, 21 deletions
diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md
index 0e445272..8ff0a080 100644
--- a/doc/md/Release-Shaarli.md
+++ b/doc/md/Release-Shaarli.md
@@ -3,6 +3,7 @@ releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Ta
3 3
4## Prerequisites 4## Prerequisites
5This guide assumes that you have: 5This guide assumes that you have:
6
6- a GPG key matching your GitHub authentication credentials 7- 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 - 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 GitHub fork of Shaarli
@@ -43,32 +44,13 @@ TBA
43``` 44```
44 45
45 46
46## Increment the version code, updated docs, create and push a signed tag 47## Increment the version code, update docs, create and push a signed tag
47### Generate documentation
48```bash
49$ cd /path/to/shaarli
50
51# create a new branch
52$ git fetch upstream
53$ git checkout upstream/master -b v0.5.0
54
55# rebuild the HTML documentation from Markdown
56$ make htmlpages
57
58# commit the changes
59$ git add doc
60$ git commit -s -m "Generate documentation for v0.5.0"
61
62# push the commit on your GitHub fork
63$ git push origin v0.5.0
64```
65
66### Create and merge a Pull Request 48### Create and merge a Pull Request
67This one is pretty straightforward ;-) 49This one is pretty straightforward ;-)
68 50
69### Bump Shaarli version to v0.x branch 51### Bump Shaarli version to v0.x branch
70 52
71``` 53```bash
72$ git checkout master 54$ git checkout master
73$ git fetch upstream 55$ git fetch upstream
74$ git pull upstream master 56$ git pull upstream master
@@ -125,6 +107,7 @@ Update `README.md` so version badges display and point to the newly released Sha
125 107
126### Create a GitHub release from a Git tag 108### Create a GitHub release from a Git tag
127From the previously drafted release: 109From the previously drafted release:
110
128- edit the release notes (if needed) 111- edit the release notes (if needed)
129- specify the appropriate Git tag 112- specify the appropriate Git tag
130- publish the release 113- publish the release
@@ -132,6 +115,7 @@ From the previously drafted release:
132 115
133### Generate and upload all-in-one release archives 116### Generate and upload all-in-one release archives
134Users with a shared hosting may have: 117Users with a shared hosting may have:
118
135- no SSH access 119- no SSH access
136- no possibility to install PHP packages or server extensions 120- no possibility to install PHP packages or server extensions
137- no possibility to run scripts 121- no possibility to run scripts
@@ -146,6 +130,7 @@ $ make release_archive
146``` 130```
147 131
148This will create the following archives: 132This will create the following archives:
133
149- `shaarli-vX.Y.Z-full.tar` 134- `shaarli-vX.Y.Z-full.tar`
150- `shaarli-vX.Y.Z-full.zip` 135- `shaarli-vX.Y.Z-full.zip`
151 136