Making Docker deploys possible - with readme updates

Author: tfennelly

Dockerfile

@@ -7,6 +7,4 @@ MAINTAINER Tom Fennelly <[email protected]>
 # clone the smooks repo
 RUN git clone https://github.com/smooks/smooks.git /home/smooks
 
-ADD settings_codehaus.xml /home/smooks/settings.xml
-
 WORKDIR /home/smooks

RELEASE.md

@@ -1,5 +1,5 @@
 ## Smooks Release process
-This section describes the process to create a release for Smooks. To do this you will to have a codehaus account. 
+This section describes the process to create a release for Smooks. To do this you will need a codehaus account.
 
 ### Generate a keypair for signing artifacts
 To deploy to Nexus it is required that the artifacts are signed. This section describes how to generate the keys for signing:
@@ -10,7 +10,7 @@ Install [pgp](http://www.openpgp.org/resources/downloads.shtml). For example, us
 
 Now, generate the keypair:
 
-    gpg —gen-key
+    gpg --gen-key
 
 List the key to get the public key identifier:
 
@@ -27,24 +27,6 @@ For others to be able to verify the signature, in our case Nexus must be able to
 
 In the example above we are using the _pub_ identifer.
 
-### Update settings.xml
-Update your settings.xml with the correct credentials:
-
-    <settings>
-        <servers>
-            <server>
-                <id>codehaus-nexus-snapshots</id>
-                <username>username</username>
-                <password>xxxx</password>
-            </server>
-            <server>
-                <id>codehaus-nexus-staging</id>
-                <username>username</username>
-                <password>xxxx</password>
-            </server>
-       </servers>
-    </settings>
-
 ### Update the project version number
 We need to update the project version number. This need to be done once for in the root project and once for the
 smooks-examples module. The reason for this is that the smooks-examples module does has a different parent.
@@ -63,12 +45,55 @@ And if you are not happy you can revert using:
 
 When you are done you should commit and tag.
 
-### Run the deploy goal/target
+### Deploy artifacts to Codehaus Nexus repository
+
+There are 2 ways of doing this, depending on the OS you are running on.  In either case, this should build and upload all artifacts to the [Codehaus Nexus maven Repository](https://nexus.codehaus.org) ([see HAUSEMATE docs for more details](http://docs.codehaus.org/display/HAUSMATES/Codehaus+Maven+Repository+Usage+Guide)), from which we can test and hopefully release the artifacts.
+
+
+#### Deploy artifacts from a Linux type OS (including Mac OSX)
+Simple run:
+
+```
+./deploy.sh -u <codehaus-username> -p <codehaus-password> -g <passphrase-of-gpg-key>
+```
+
+#### Deploy artifacts from a Docker container
+We use Docker to build and deploy artifacts, guaranteeing a consistent build environment.  
+
+Assuming you have Docker installed on the local host system, we install the `smooks` image:
+
+```
+docker build -t smooks github.com/smooks/smooks
+```
+
+One catch of running the build in a Docker container is that we need to make the GPG key available to the build running in the Docker container.  So, we need to mount the host system's `~/.gnupg` directory into the docker container as the root account's `~/.gnupg` directory by adding `-v $HOME/.gnupg:/.gnupg` to the docker commands.
+
+#### Deploy artifacts from a non-Linux type OS (Windows etc)
+
+Update your `~/.m2/settings.xml` with the correct Codehaus credentials (same as your Xircles login details):
+
+```
+<settings>
+    <servers>
+        <server>
+            <id>codehaus-nexus-snapshots</id>
+            <username>username</username>
+            <password>xxxx</password>
+        </server>
+        <server>
+            <id>codehaus-nexus-staging</id>
+            <username>username</username>
+            <password>xxxx</password>
+        </server>
+   </servers>
+</settings>
+```
+
 Now you are ready to run the maven deploy goal:
 
-    mvn clean deploy -Pdeploy -Dgpg.passphrase=key-password
+    mvn clean deploy -Pdeploy -Dgpg.passphrase=<passphrase-of-gpg-key> -Dmaven.test.skip=true
 
-This should build and upload and complete successfully. Things will be uploaded to the [Codehaus Nexus maven Repository](https://nexus.codehaus.org) ([see HAUSEMATE docs for more details](http://docs.codehaus.org/display/HAUSMATES/Codehaus+Maven+Repository+Usage+Guide)).
+### Releasing artifacts from Codehaus Nexus repository
 
 You log into the Codehaus Nexus repo using your [Xircles](http://xircles.codehaus.org/) userid and password.  From there, take a look at the “Staging Repository”. The staging repository is where you can inspect what was uploaded and make sure that everything looks peachy.
 If it doesn't, you can drop the repository and fix the issue and deploy again. Once you think everything is in order you need to “Close” the repository. Closing will run a number of verification
@@ -88,6 +113,3 @@ Optionally verify the tag:
 Push the tag:
 
     git push upstream vx.x.x
-
-
-

deploy.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+#
+# Run:
+# ./deploy.sh -u <codehaus-username> -p <codehaus-password> -g <passphrase-of-gpg-key>
+#
+
+while getopts u:p:g: option
+do
+    case "${option}"
+    in
+        u) USERNM=${OPTARG};;
+        p) PASSWD=${OPTARG};;
+        g) GPGPPH=${OPTARG};;
+    esac
+done
+
+export CH_UN=$USERNM
+export CH_PW=$PASSWD
+
+mvn clean deploy -Pdeploy -Dgpg.passphrase=$GPGPPH -Dmaven.test.skip=true --settings settings_codehaus.xml

settings_codehaus.xml

@@ -1 +1,16 @@
-<test></test>
+<settings>
+    <servers>
+        <server>
+            <id>codehaus-nexus-snapshots</id>
+            <!-- This is your codehaus login i.e. same as for JIRA etc -->
+            <username>${env.CH_UN}</username>
+            <password>${env.CH_PW}</password>
+        </server>
+        <server>
+            <id>codehaus-nexus-staging</id>
+            <!-- This is your codehaus login i.e. same as for JIRA etc -->
+            <username>${env.CH_UN}</username>
+            <password>${env.CH_PW}</password>
+        </server>
+    </servers>
+</settings>