X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FRelease-Shaarli.md;h=e22eabc9f32af872d7771a3cda37391261fc6464;hb=6128ab6a55430a2b705be31ff417c0c552a0db1f;hp=0e445272e182799b8fa068d04ab01a2486b2305e;hpb=f09e1e318e0b1c72aa659c20b715be508009175f;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md index 0e445272..e22eabc9 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 @@ -25,6 +26,7 @@ GitHub allows drafting the release note for the upcoming release, from the [Rele This file should contain the same information as the release note draft for the upcoming version. Update it to: + - add new entries (additions, fixes, etc.) - mark the current version as released by setting its date and link - add a new section for the future unreleased version @@ -43,24 +45,11 @@ TBA ``` -## Increment the version code, updated docs, create and push a signed tag -### Generate documentation +## Increment the version code, update docs, create and push a signed tag +### Update the list of Git contributors ```bash -$ cd /path/to/shaarli - -# create a new branch -$ git fetch upstream -$ git checkout upstream/master -b v0.5.0 - -# rebuild the HTML documentation from Markdown -$ make htmlpages - -# commit the changes -$ git add doc -$ git commit -s -m "Generate documentation for v0.5.0" - -# push the commit on your GitHub fork -$ git push origin v0.5.0 +$ make authors +$ git commit -s -m "Update AUTHORS" ``` ### Create and merge a Pull Request @@ -68,7 +57,7 @@ This one is pretty straightforward ;-) ### Bump Shaarli version to v0.x branch -``` +```bash $ git checkout master $ git fetch upstream $ git pull upstream master @@ -125,6 +114,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 +122,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 +137,7 @@ $ make release_archive ``` This will create the following archives: + - `shaarli-vX.Y.Z-full.tar` - `shaarli-vX.Y.Z-full.zip`