X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FRelease-Shaarli.md;h=bb2b3b5cb4c90dd36dfccb3783b7141638ab04d7;hb=43ad7c8e825057747ccf02049050b323878952a7;hp=0e445272e182799b8fa068d04ab01a2486b2305e;hpb=57ee53d6c6be4b641764b0a635b2998c6cdc8197;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md index 0e445272..bb2b3b5c 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 ## Prerequisites This guide assumes that you have: + - a GPG key matching your GitHub authentication credentials - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig` - a GitHub fork of Shaarli @@ -43,7 +44,7 @@ TBA ``` -## Increment the version code, updated docs, create and push a signed tag +## Increment the version code, update docs, create and push a signed tag ### Generate documentation ```bash $ cd /path/to/shaarli @@ -125,6 +126,7 @@ Update `README.md` so version badges display and point to the newly released Sha ### Create a GitHub release from a Git tag From the previously drafted release: + - edit the release notes (if needed) - specify the appropriate Git tag - publish the release @@ -132,6 +134,7 @@ From the previously drafted release: ### Generate and upload all-in-one release archives Users with a shared hosting may have: + - no SSH access - no possibility to install PHP packages or server extensions - no possibility to run scripts @@ -146,6 +149,7 @@ $ make release_archive ``` This will create the following archives: + - `shaarli-vX.Y.Z-full.tar` - `shaarli-vX.Y.Z-full.zip`