You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wookie.apache.org by bu...@apache.org on 2012/04/25 17:15:48 UTC
svn commit: r814411 - in /websites/staging/wookie/trunk/content: ./
wookie/docs/developer/release-process.html
Author: buildbot
Date: Wed Apr 25 15:15:48 2012
New Revision: 814411
Log:
Staging update by buildbot for wookie
Modified:
websites/staging/wookie/trunk/content/ (props changed)
websites/staging/wookie/trunk/content/wookie/docs/developer/release-process.html
Propchange: websites/staging/wookie/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Apr 25 15:15:48 2012
@@ -1 +1 @@
-1330325
+1330333
Modified: websites/staging/wookie/trunk/content/wookie/docs/developer/release-process.html
==============================================================================
--- websites/staging/wookie/trunk/content/wookie/docs/developer/release-process.html (original)
+++ websites/staging/wookie/trunk/content/wookie/docs/developer/release-process.html Wed Apr 25 15:15:48 2012
@@ -87,33 +87,44 @@ It can also be used to automatically sig
<p>You should familiarize yourself with the ant scripts in the project as they are used to create the artifacts. We will go over the specific tasks for generating them
in more detail later.</p>
<p>Note the following 3 artifacts that are to be generated. Eventually these should be made available to download from <a href="http://www.apache.org/dist/incubator/wookie/">http://www.apache.org/dist/incubator/wookie/</a></p>
-<div class="codehilite"><pre><span class="mi">1</span><span class="o">.</span> <span class="n">A</span> <span class="n">source</span> <span class="n">release</span> <span class="p">(</span><span class="n">apache</span><span class="o">-</span><span class="n">wookie</span><span class="o">-</span><span class="n">VERSION</span><span class="o">-</span><span class="n">src</span><span class="o">.</span><span class="n">zip</span><span class="p">)</span> <span class="p">(</span><span class="ow">and</span> <span class="n">also</span> <span class="n">a</span> <span class="n">tar</span><span class="o">.</span><span class="n">gz</span> <span class="n">version</span><span class="p">)</span>
- <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="k">for</span> <span class="n">users</span> <span class="n">who</span> <span class="n">wish</span> <span class="n">to</span> <span class="n">download</span> <span class="n">the</span> <span class="n">code</span> <span class="ow">and</span> <span class="n">build</span> <span class="n">it</span> <span class="n">themselves</span>
-<span class="mi">2</span><span class="o">.</span> <span class="n">A</span> <span class="n">standalone</span> <span class="n">release</span> <span class="p">(</span><span class="n">apache</span><span class="o">-</span><span class="n">wookie</span><span class="o">-</span><span class="n">VERSION</span><span class="o">-</span><span class="n">standalone</span><span class="o">.</span><span class="n">zip</span><span class="p">)</span> <span class="p">(</span><span class="ow">and</span> <span class="n">also</span> <span class="n">a</span> <span class="n">tar</span><span class="o">.</span><span class="n">gz</span> <span class="n">version</span><span class="p">)</span>
- <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="n">aimed</span> <span class="n">at</span> <span class="n">first</span> <span class="nb">time</span><span class="o">/</span><span class="n">casual</span> <span class="n">users</span> <span class="ow">and</span> <span class="n">incorparates</span> <span class="n">a</span> <span class="n">preconfigured</span> <span class="n">Jetty</span> <span class="ow">and</span> <span class="n">Derby</span> <span class="n">DB</span> <span class="n">to</span> <span class="n">work</span> <span class="n">out</span> <span class="n">of</span> <span class="n">the</span> <span class="n">box</span>
-<span class="mi">3</span><span class="o">.</span> <span class="n">A</span> <span class="n">WAR</span> <span class="n">release</span> <span class="p">(</span><span class="n">apache</span><span class="o">-</span><span class="n">wookie</span><span class="o">-</span><span class="n">VERSION</span><span class="o">-</span><span class="n">war</span><span class="o">.</span><span class="n">zip</span><span class="p">)</span> <span class="p">(</span><span class="ow">and</span> <span class="n">also</span> <span class="n">a</span> <span class="n">tar</span><span class="o">.</span><span class="n">gz</span> <span class="n">version</span><span class="p">)</span>
- <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="n">aimed</span> <span class="n">towards</span> <span class="n">users</span> <span class="n">who</span> <span class="n">have</span> <span class="n">an</span> <span class="n">existing</span> <span class="n">server</span> <span class="n">setup</span> <span class="p">(</span><span class="n">their</span> <span class="n">own</span> <span class="n">tomcat</span><span class="o">/</span><span class="n">mysql</span> <span class="nb">system</span> <span class="k">for</span> <span class="n">example</span><span class="p">)</span>
- <span class="ow">and</span> <span class="n">want</span> <span class="n">to</span> <span class="n">deploy</span> <span class="n">it</span> <span class="n">alongside</span> <span class="n">their</span> <span class="n">own</span> <span class="n">existing</span> <span class="n">web</span> <span class="n">applications</span><span class="o">.</span> <span class="n">The</span> <span class="n">bundled</span> <span class="n">documentation</span> <span class="n">is</span> <span class="n">geared</span> <span class="n">towards</span>
- <span class="n">configuring</span> <span class="n">it</span> <span class="k">for</span> <span class="n">tomcat</span><span class="o">/</span><span class="n">mysql</span> <span class="n">but</span> <span class="n">it</span> <span class="n">also</span> <span class="n">includes</span> <span class="n">scripts</span> <span class="k">for</span> <span class="n">other</span> <span class="n">databases</span><span class="o">.</span>
-
-<span class="n">Additionally</span> <span class="n">there</span> <span class="n">are</span> <span class="mi">3</span> <span class="n">Nexus</span> <span class="n">artifacts</span> <span class="n">to</span> <span class="n">generate</span><span class="o">.</span> <span class="n">Eventually</span> <span class="n">these</span> <span class="n">should</span> <span class="n">be</span> <span class="n">made</span> <span class="n">available</span> <span class="n">from</span> <span class="n">the</span> <span class="n">Nexus</span> <span class="n">Repository</span><span class="o">.</span>
-
-<span class="mi">4</span><span class="o">.</span> <span class="n">A</span> <span class="n">Nexus</span> <span class="n">artifact</span> <span class="n">of</span> <span class="n">the</span> <span class="n">wookie</span> <span class="n">connector</span> <span class="n">subproject</span> <span class="p">(</span><span class="n">wookie</span><span class="o">-</span><span class="n">java</span><span class="o">-</span><span class="n">connector</span><span class="o">-</span><span class="n">VERSION</span><span class="o">.</span><span class="n">jar</span><span class="p">)</span>
- <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="k">for</span> <span class="n">users</span> <span class="n">who</span> <span class="n">want</span> <span class="n">to</span> <span class="n">incorporate</span> <span class="n">the</span> <span class="n">connector</span> <span class="n">part</span> <span class="n">of</span> <span class="n">wookie</span> <span class="n">only</span> <span class="n">as</span> <span class="n">a</span> <span class="n">jar</span> <span class="n">via</span> <span class="n">maven</span>
-<span class="mi">5</span><span class="o">.</span> <span class="n">A</span> <span class="n">Nexus</span> <span class="n">artifact</span> <span class="n">of</span> <span class="n">the</span> <span class="n">wookie</span> <span class="n">parser</span> <span class="n">subproject</span> <span class="p">(</span><span class="n">wookie</span><span class="o">-</span><span class="n">parser</span><span class="o">-</span><span class="n">VERSION</span><span class="o">.</span><span class="n">jar</span><span class="p">)</span>
- <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="k">for</span> <span class="n">users</span> <span class="n">who</span> <span class="n">want</span> <span class="n">to</span> <span class="n">incorporate</span> <span class="n">the</span> <span class="n">w3c</span> <span class="n">widget</span> <span class="n">parser</span> <span class="n">part</span> <span class="n">of</span> <span class="n">wookie</span> <span class="n">only</span> <span class="n">as</span> <span class="n">a</span> <span class="n">jar</span> <span class="n">via</span> <span class="n">maven</span>
-<span class="mi">6</span><span class="o">.</span> <span class="n">A</span> <span class="n">Nexus</span> <span class="n">artifact</span> <span class="n">of</span> <span class="n">the</span> <span class="n">wookie</span> <span class="n">WAR</span> <span class="p">(</span><span class="n">wookie</span><span class="o">-</span><span class="n">VERSION</span><span class="o">.</span><span class="n">war</span><span class="p">)</span>
- <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="k">for</span> <span class="n">users</span> <span class="n">who</span> <span class="n">want</span> <span class="n">to</span> <span class="n">include</span> <span class="n">a</span> <span class="n">self</span> <span class="n">contained</span> <span class="n">version</span> <span class="n">of</span> <span class="n">the</span> <span class="n">wookie</span><span class="o">.</span><span class="n">war</span> <span class="n">in</span> <span class="n">their</span> <span class="n">own</span> <span class="n">projects</span> <span class="n">via</span> <span class="n">maven</span><span class="o">.</span>
- <span class="p">(</span><span class="n">the</span> <span class="n">difference</span> <span class="n">between</span> <span class="n">this</span> <span class="ow">and</span> <span class="c1">#3 is that this one is configured & bundled with Derby DB.)</span>
-</pre></div>
-
-
+<ol>
+<li>A source release (apache-wookie-VERSION-src.zip) (and also a tar.gz version)<ul>
+<li>this is for users who wish to download the code and build it themselves</li>
+</ul>
+</li>
+<li>A standalone release (apache-wookie-VERSION-standalone.zip) (and also a tar.gz version)<ul>
+<li>this is aimed at first time/casual users and incorparates a preconfigured Jetty and Derby DB to work out of the box</li>
+</ul>
+</li>
+<li>A WAR release (apache-wookie-VERSION-war.zip) (and also a tar.gz version)<ul>
+<li>this is aimed towards users who have an existing server setup (their own tomcat/mysql system for example)
+and want to deploy it alongside their own existing web applications. The bundled documentation is geared towards
+configuring it for tomcat/mysql but it also includes scripts for other databases.</li>
+</ul>
+</li>
+</ol>
+<p>Additionally there are 3 Nexus artifacts to generate. Eventually these should be made available from the Nexus Repository.</p>
+<ol>
+<li>A Nexus artifact of the wookie connector subproject (wookie-java-connector-VERSION.jar)<ul>
+<li>this is for users who want to incorporate the connector part of wookie only as a jar via maven</li>
+</ul>
+</li>
+<li>A Nexus artifact of the wookie parser subproject (wookie-parser-VERSION.jar)<ul>
+<li>this is for users who want to incorporate the w3c widget parser part of wookie only as a jar via maven</li>
+</ul>
+</li>
+<li>A Nexus artifact of the wookie WAR (wookie-VERSION.war)<ul>
+<li>this is for users who want to include a self contained version of the wookie.war in their own projects via maven.
+(the difference between this and #3 is that this one is configured & bundled with Derby DB.)</li>
+</ul>
+</li>
+</ol>
<h2 id="steps-to-making-a-release">Steps to making a release</h2>
<h3 id="1-resolve-outstanding-jira-issues-marked-against-this-planned-release">1. Resolve Outstanding JIRA issues marked against this planned release</h3>
<div class="codehilite"><pre> <span class="mi">1</span><span class="o">.</span> <span class="n">Analyse</span> <span class="nb">open</span> <span class="n">issues</span>
- <span class="mi">2</span><span class="o">.</span> <span class="n">Issues</span> <span class="n">should</span> <span class="n">be</span> <span class="n">FIXED</span> <span class="ow">and</span> <span class="n">verified</span> <span class="n">to</span> <span class="n">ensure</span> <span class="n">they</span> <span class="n">are</span> <span class="n">truly</span> <span class="n">fixed</span> <span class="ow">and</span> <span class="n">thus</span> <span class="n">marked</span> <span class="n">as</span> <span class="n">verified</span>
- <span class="mi">3</span><span class="o">.</span> <span class="n">Alternatively</span><span class="p">,</span> <span class="n">in</span> <span class="n">some</span> <span class="n">cases</span> <span class="nb">open</span> <span class="n">issues</span> <span class="n">can</span> <span class="n">be</span> <span class="n">moved</span> <span class="n">to</span> <span class="n">the</span> <span class="k">next</span> <span class="n">planned</span> <span class="n">release</span>
- <span class="mi">4</span><span class="o">.</span> <span class="n">No</span> <span class="nb">open</span> <span class="n">issues</span> <span class="n">should</span> <span class="n">remain</span> <span class="n">against</span> <span class="n">this</span> <span class="n">intended</span> <span class="n">release</span> <span class="n">before</span> <span class="n">continuing</span>
+ <span class="mi">1</span><span class="o">.</span> <span class="n">Issues</span> <span class="n">should</span> <span class="n">be</span> <span class="n">FIXED</span> <span class="ow">and</span> <span class="n">verified</span> <span class="n">to</span> <span class="n">ensure</span> <span class="n">they</span> <span class="n">are</span> <span class="n">truly</span> <span class="n">fixed</span> <span class="ow">and</span> <span class="n">thus</span> <span class="n">marked</span> <span class="n">as</span> <span class="n">verified</span>
+ <span class="mi">1</span><span class="o">.</span> <span class="n">Alternatively</span><span class="p">,</span> <span class="n">in</span> <span class="n">some</span> <span class="n">cases</span> <span class="nb">open</span> <span class="n">issues</span> <span class="n">can</span> <span class="n">be</span> <span class="n">moved</span> <span class="n">to</span> <span class="n">the</span> <span class="k">next</span> <span class="n">planned</span> <span class="n">release</span>
+ <span class="mi">1</span><span class="o">.</span> <span class="n">No</span> <span class="nb">open</span> <span class="n">issues</span> <span class="n">should</span> <span class="n">remain</span> <span class="n">against</span> <span class="n">this</span> <span class="n">intended</span> <span class="n">release</span> <span class="n">before</span> <span class="n">continuing</span>
<span class="o">-</span> <span class="n">The</span> <span class="n">only</span> <span class="n">exception</span> <span class="n">to</span> <span class="n">this</span> <span class="n">is</span> <span class="k">if</span> <span class="n">an</span> <span class="n">issue</span> <span class="n">directly</span> <span class="n">addresses</span> <span class="n">the</span> <span class="n">build</span> <span class="n">process</span><span class="p">,</span> <span class="n">such</span> <span class="n">as</span> <span class="s">"create build for release"</span> <span class="n">type</span> <span class="n">issue</span><span class="o">.</span>
</pre></div>