Documented play-slick release process. Fix #200

RELEASING.md

@@ -0,0 +1,48 @@
+# Releasing play-slick
+
+Releasing a new version of play-slick is truly simple.
+
+## Precondition
+
+* An account on vegemite.
+
+## Release steps
+
+* Log in vegemite.
+* type `sudo su - play`, and enter your account's password.
+* type `cd deploy`.
+* and finally type `./release --project play-slick --branch <branch-to-release>`, where <branch-to-release> is the name of the branch you want to release.
+
+That will start the build. The output should be similar to
+
+```
+play ▶ [] ~/deploy$ ./release --project play-slick --branch master
+This will release play-slick from branch master using JDK8, continue? [y/n] y
+java version "1.8.0_31"
+...
+```
+
+The script will eventually stop and ask you the version number of the release, and the next version you want your branch to be moved to.
+
+```
+...
+Release version [1.0.1] :
+Next version [1.0.2-SNAPSHOT] : 
+```
+Type ENTER if the version between square brackets suits you. If it doesn't, provide the desired version to release.
+
+Once the binaries are successfully deployed, you will be prompted if you wish to push your changes to the remote repository:
+
+```
+...
+[info] Dropping staging repository [comtypesafe-1354] status:released, profile:com.typesafe(34c112e991655)
+[info] Dropped successfully: comtypesafe-1354
+[info] Setting version to '1.0.2-SNAPSHOT'.
+[info] Reapplying settings...
+[info] Set current project to play-slick-root (in build file:/home/play/deploy/play-slick/)
+[info] [master fa73a4f] Setting version to 1.0.2-SNAPSHOT
+[info]  1 file changed, 1 insertion(+), 1 deletion(-)
+Push changes to the remote repository (y/n)? [y]
+```
+
+Typing `y` will create a tag in the remote repository and push a commit to update the branch version number.