diff options
Diffstat (limited to 'doc/Release-Shaarli.md')
-rw-r--r-- | doc/Release-Shaarli.md | 42 |
1 files changed, 40 insertions, 2 deletions
diff --git a/doc/Release-Shaarli.md b/doc/Release-Shaarli.md index 5cbcd79a..556a96ee 100644 --- a/doc/Release-Shaarli.md +++ b/doc/Release-Shaarli.md | |||
@@ -10,9 +10,39 @@ This guide assumes that you have: | |||
10 | - a local clone of your Shaarli fork, with the following remotes: | 10 | - a local clone of your Shaarli fork, with the following remotes: |
11 | - `origin` pointing to your GitHub fork | 11 | - `origin` pointing to your GitHub fork |
12 | - `upstream` pointing to the main Shaarli repository | 12 | - `upstream` pointing to the main Shaarli repository |
13 | - maintainer permissions on the main Shaarli repository (to push the signed tag) | 13 | - maintainer permissions on the main Shaarli repository, to: |
14 | - push the signed tag | ||
15 | - create a new release | ||
14 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) | 16 | - [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed[](.html) |
15 | 17 | ||
18 | ## GitHub release draft and `CHANGELOG.md` | ||
19 | See http://keepachangelog.com/en/0.3.0/ for changelog formatting. | ||
20 | |||
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`.[](.html) | ||
23 | |||
24 | ### `CHANGELOG.md` | ||
25 | This file should contain the same information as the release note draft for the upcoming version. | ||
26 | |||
27 | Update it to: | ||
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 | ||
31 | |||
32 | ```bash | ||
33 | $ cd /path/to/shaarli | ||
34 | |||
35 | $ nano CHANGELOG.md | ||
36 | |||
37 | [...][](.html) | ||
38 | ## vA.B.C - UNRELEASED | ||
39 | TBA | ||
40 | |||
41 | ## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html) | ||
42 | [...][](.html) | ||
43 | ``` | ||
44 | |||
45 | |||
16 | ## Increment the version code, create and push a signed tag | 46 | ## Increment the version code, create and push a signed tag |
17 | ### Bump Shaarli's version | 47 | ### Bump Shaarli's version |
18 | ```bash | 48 | ```bash |
@@ -72,7 +102,15 @@ gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F | |||
72 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) | 102 | gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html) |
73 | ``` | 103 | ``` |
74 | 104 | ||
75 | ## Generate and upload all-in-one release archives | 105 | ## Publish the GitHub release |
106 | ### Create a GitHub release from a Git tag | ||
107 | From the previously drafted release: | ||
108 | - edit the release notes (if needed) | ||
109 | - specify the appropriate Git tag | ||
110 | - publish the release | ||
111 | - profit! | ||
112 | |||
113 | ### Generate and upload all-in-one release archives | ||
76 | Users with a shared hosting may have: | 114 | Users with a shared hosting may have: |
77 | - no SSH access | 115 | - no SSH access |
78 | - no possibility to install PHP packages or server extensions | 116 | - no possibility to install PHP packages or server extensions |