From 5c5c6e6e46b79b452bdc6d7155a5fd98fb023d30 Mon Sep 17 00:00:00 2001
From: Romain PELISSE <belaran@gmail.com>
Date: Wed, 28 Nov 2012 22:42:13 +0100
Subject: [PATCH] site: add missing information on release

---
 pmd/src/site/xdocs/pmd-release-process.xml | 38 ++++++++++++----------
 1 file changed, 21 insertions(+), 17 deletions(-)

diff --git a/pmd/src/site/xdocs/pmd-release-process.xml b/pmd/src/site/xdocs/pmd-release-process.xml
index 4eefeacef1..72ef61d390 100644
--- a/pmd/src/site/xdocs/pmd-release-process.xml
+++ b/pmd/src/site/xdocs/pmd-release-process.xml
@@ -24,12 +24,16 @@ $ git pull
 $ git status
 </source>
 
-<p>Ensure all the new rules are listed in a
-src/main/resources/rulesets/releases/&lt;version&gt;.xml file.</p>
+<p><strong>Checklist for release preparation:</strong></p>
 
-<p>Update the "download" and "what's new" link in site.pre.xml.</p>
-
-<p>Update version/release info in etc/changelog.txt.</p>
+<ul>
+  <li>Ensure all the new rules are listed in a the proper file:
+    <source>src/main/resources/rulesets/releases/&lt;version&gt;.xml file.</source>
+  </li>
+  <li>Update the <em>"download"</em> and <em>"what's new"</em> link in <strong>site.pre.xml</strong>.</li>
+  <li>Update version/release info in <strong>etc/changelog.txt</strong>.</li>
+  <li>Update pmd.website.baseurl in <strong>pom.xml</strong></li>
+</ul>
 
 <source>
 $ mvn verify post-site    #(order of targets DOES matter)
@@ -49,23 +53,23 @@ $ git commit -a -m "pmd: Prepare pmd release &lt;version&gt;"
 </subsection>
 
 <subsection name="Release Branch">
-<p>
-Let maven create a release branch (note - this is of course not needed if you
-are already on a release/maintenance branch). Maven will automatically increase
-the version in branch master. In case you create a alpha/preview release and you
-want to stay with the current version in master, use these
-additional properties:
--DupdateBranchVersions=true -DupdateWorkingCopyVersions=false</p>
+<p>Let's have maven create a release branch for us (<em>note - this is of course not
+needed if you are already on a release/maintenance branch</em>). Maven will automatically
+increase the version in branch master.</p>
 
 <source>
 $ mvn release:branch -DbranchName=pmd/&lt;version&gt;.x
 </source>
 
-<p>
-Note: The property pushChanges is set to false, so that we can manually
+<em>In case you create a alpha/preview release and you want to stay with the current
+version in master, use these additional properties:</em>
+
+<source>$ mvn -DupdateBranchVersions=true -DupdateWorkingCopyVersions=false ...</source>
+
+<p>Note: The property pushChanges is set to false, so that we can manually
 push all changes done during the release at the end, when we are sure,
-that everything is fine.
-</p>
+that everything is fine.</p>
+
 </subsection>
 
 <subsection name="Create a release">
@@ -176,4 +180,4 @@ $ ssh your_sf_login@shell.sourceforge.net "shutdown"
 </subsection>
 </section>
 </body>
-</document>
\ No newline at end of file
+</document>