perfsonar development work

Author: dante.delvaux
Date: 2013-05-03 11:52:19 +0100 (Fri, 03 May 2013)
New Revision: 6346

Modified:
   trunk/RELEASES.txt
Log:
Documenting the release process

Modified: trunk/RELEASES.txt
===================================================================
--- trunk/RELEASES.txt  2013-05-02 18:12:57 UTC (rev 6345)
+++ trunk/RELEASES.txt  2013-05-03 10:52:19 UTC (rev 6346)
@@ -25,29 +25,42 @@
    - in trunk, the version number will be increased and -SNAPSHOT added again
    - the module will be published to the artifactory server
 
+Replacing references to -SNAPSHOT with a new release
+----------------------------------------------------
+After having released a new module, run:
+    mvn versions:use-releases
+
+After having released a new parent, run:
+    mvn versions:update-parent
+ 
 With Jenkins
 ------------
-Ideally, making a release would be done through Jenkins, with the pS-rel job 
at
-https://ci.geant.net/jenkins/view/perfSONAR/job/pS-rel
+This is the recommended way of making a release: through the pS-rel Jenkins 
job
+at https://ci.geant.net/jenkins/view/perfSONAR/job/pS-rel
 
-You got to the "Release" action, choose the module you want to release and 
make
-it happen!  All is done through the maven-release-plugin:
+You go to the "Release" action, choose the module you want to release and 
make
+it happen!  The manual process is automated through the maven-release-plugin 
and
+the versions-maven-plugin:
  - removing the -SNAPSHOT from the module version number
  - tagging the release in SVN
  - increasing the module version number and adding -SNAPSHOT again
+ - installing locally (mvn on the Jenkins server cannot deploy to 
Artifactory)
+ - replacing -SNAPSHOT with the released artifact in other modules 
dependencies
+ - (at some point we should also add the versions:update-parent goal)
  - publishing in the artifactory server
 
-*But* the Jenkins server is currently not configured to be able to commit to 
our
-SVN repository.  See https://issues.geant.net/jira/browse/SWDSD-446
+All, except the last step, are currently configured in the Jenkins job.  See
+https://issues.geant.net/jira/browse/SWDSD-446 for more information on why
 
-Replacing references to -SNAPSHOT with a new release
-----------------------------------------------------
-After having released a new module, run:
-    mvn versions:use-releases
+So now we currently need to publish manually with:
+    mvn release:perform -pl module-name \
+    
-DconnectionUrl=scm:svn:http://svn.geant.net/GEANTA2/ps-java-services/tags/module-name/x.y.z/
 
-After having released a new parent, run:
-    mvn versions:update-parent
- 
+(replace the module-name and version numbers x.y.z, of course)
+
+This deployment (default release:perform) also publish a source and a javadoc
+jars.  We need to see if we want to keep this.
+
 Releasing a perfSONAR service
 -----------------------------
 When releasing a full perfSONAR service, this one must depend on released 
java
@@ -61,7 +74,7 @@
 maven plugins or dependencies should be upgraded.  This can be done with the
 versions-maven-plugin by running:
     mvn versions:display-plugin-updates versions:display-dependency-updates \
-      -pl module-name
+    -pl module-name
     
 However, upgrading a dependency version means you need to test your code 
again
 to see if no changes have been introduced.