X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2FRelease-Shaarli.html;h=0d9fa3e1c91bb366c0c6a9823e975c0577a45f7d;hb=3cc8c898307ad53507a128db2b11238be2641c32;hp=69b4947870d6da06c50b67a3a2e47d123f90043a;hpb=fa72470d5d14082e6c05b83f3f32439298dbc0e3;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html index 69b49478..0d9fa3e1 100644 --- a/doc/Release-Shaarli.html +++ b/doc/Release-Shaarli.html @@ -52,18 +52,17 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
See Git - Maintaining a project - Tagging your [](.html)
releases.
This guide assumes that you have:
origin
pointing to your GitHub forkupstream
pointing to the main Shaarli repositoryCHANGELOG.md
See http://keepachangelog.com/en/0.3.0/ for changelog formatting.
+GitHub allows drafting the release note for the upcoming release, from the Releases page. This way, the release note can be drafted while contributions are merged to master
.
CHANGELOG.md
This file should contain the same information as the release note draft for the upcoming version.
+Update it to:
+$ cd /path/to/shaarli
+
+$ nano CHANGELOG.md
+
+[...][](.html)
+## vA.B.C - UNRELEASED
+TBA
+
+## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)
+[...][](.html)
$ cd /path/to/shaarli
+$ cd /path/to/shaarli
# create a new branch
-$ git fetch upstream
-$ git checkout upstream/master -b v0.5.0
+$ git fetch upstream
+$ git checkout upstream/master -b v0.5.0
# bump the version number
-$ vim index.php shaarli_version.php
+$ vim index.php shaarli_version.php
# rebuild the documentation from the wiki
-$ make htmldoc
+$ make htmldoc
# commit the changes
-$ git add index.php shaarli_version.php doc
-$ git commit -s -m "Bump version to v0.5.0"
+$ git add index.php shaarli_version.php doc
+$ git commit -s -m "Bump version to v0.5.0"
# push the commit on your GitHub fork
-$ git push origin v0.5.0
+$ git push origin v0.5.0
This one is pretty straightforward ;-)
# update your local copy
-$ git checkout master
-$ git fetch upstream
-$ git pull upstream master
+$ git checkout master
+$ git fetch upstream
+$ git pull upstream master
# create a signed tag
-$ git tag -s -m "Release v0.5.0" v0.5.0
+$ git tag -s -m "Release v0.5.0" v0.5.0
# push it to "upstream"
-$ git push --tags upstream
v0.5.0
is the first GPG-signed tag pushed on the Community Shaarli.
Let's have a look at its signature!
-$ cd /path/to/shaarli
-$ git fetch upstream
+$ cd /path/to/shaarli
+$ git fetch upstream
# get the SHA1 reference of the tag
-$ git show-ref tags/v0.5.0
-f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
+$ git show-ref tags/v0.5.0
+f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
# verify the tag signature information
-$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
-gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
-gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
+$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
+gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
+gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
From the previously drafted release:
+Users with a shared hosting may have:
+To ease Shaarli installations, it is possible to generate and upload additional release archives,
+that will contain Shaarli code plus all required third-party libraries:
$ make release_archive
This will create the following archives:
+shaarli-vX.Y.Z-full.tar
shaarli-vX.Y.Z-full.zip
The archives need to be manually uploaded on the previously created GitHub release.