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:27:57 UTC
svn commit: r814416 - in /websites/staging/wookie/trunk/content: ./
wookie/docs/developer/release-process.html
Author: buildbot
Date: Wed Apr 25 15:27:56 2012
New Revision: 814416
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:27:56 2012
@@ -1 +1 @@
-1330333
+1330343
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:27:56 2012
@@ -121,64 +121,66 @@ configuring it for tomcat/mysql but it a
</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">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>
-
-
+<ol>
+<li>Analyse open issues</li>
+<li>Issues should be FIXED and verified to ensure they are truly fixed and thus marked as verified</li>
+<li>Alternatively, in some cases open issues can be moved to the next planned release</li>
+<li>No open issues should remain against this intended release before continuing<ul>
+<li>The only exception to this is if an issue directly addresses the build process, such as "create build for release" type issue.</li>
+</ul>
+</li>
+</ol>
<h3 id="2-communicate-with-committers-regarding-new-release">2. Communicate with committers regarding new release</h3>
-<div class="codehilite"><pre><span class="n">Send</span> <span class="n">an</span> <span class="n">email</span> <span class="n">to</span> <span class="n">wookie</span><span class="o">-</span><span class="n">dev</span><span class="nv">@incubator</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span> <span class="ow">and</span> <span class="n">start</span> <span class="n">a</span> <span class="n">vote</span> <span class="n">to</span> <span class="n">discuss</span> <span class="n">whether</span> <span class="n">everybody</span> <span class="n">agrees</span> <span class="n">it</span> <span class="n">is</span> <span class="n">okay</span> <span class="n">to</span> <span class="n">go</span> <span class="n">ahead</span> <span class="ow">and</span> <span class="n">make</span> <span class="n">a</span> <span class="n">release</span><span class="o">.</span>
-<span class="n">Ideally</span> <span class="n">we</span><span class="err">'</span><span class="n">d</span> <span class="n">want</span> <span class="n">a</span> <span class="o">+</span><span class="mi">3</span> <span class="n">from</span> <span class="n">the</span> <span class="n">committers</span><span class="p">,</span> <span class="n">but</span> <span class="n">this</span> <span class="n">is</span> <span class="ow">not</span> <span class="n">always</span> <span class="n">possible</span><span class="o">.</span>
-</pre></div>
-
-
+<p>Send an email to wookie-dev@incubator.apache.org and start a vote to discuss whether everybody agrees it is okay to go ahead and make a release.
+Ideally we'd want a +3 from the committers, but this is not always possible.<br />
+</p>
<h3 id="3-check-all-licenses-notices-and-other-related-files">3. Check all Licenses, notices and other related files</h3>
-<div class="codehilite"><pre> <span class="mi">1</span><span class="o">.</span> <span class="n">Check</span> <span class="n">the</span> <span class="n">following</span> <span class="n">files</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">trunk</span><span class="o">.</span> <span class="p">(</span><span class="n">They</span> <span class="n">are</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">all</span> <span class="n">the</span> <span class="n">builds</span><span class="p">,</span> <span class="n">except</span> <span class="n">in</span> <span class="n">the</span> <span class="k">case</span> <span class="n">of</span> <span class="n">LICENSE</span> <span class="ow">and</span> <span class="n">NOTICE</span><span class="p">,</span> <span class="n">which</span> <span class="n">are</span> <span class="n">buil
d</span> <span class="n">specific</span><span class="p">)</span>
- <span class="mi">1</span><span class="o">.</span> <span class="n">README</span> <span class="o">-</span> <span class="n">this</span> <span class="n">is</span> <span class="n">usually</span> <span class="n">the</span> <span class="n">first</span> <span class="n">file</span> <span class="n">a</span> <span class="n">user</span> <span class="n">will</span> <span class="nb">read</span> <span class="n">when</span> <span class="n">they</span> <span class="n">download</span> <span class="n">either</span> <span class="n">the</span> <span class="n">source</span> <span class="ow">or</span> <span class="n">binary</span> <span class="n">versions</span> <span class="n">of</span> <span class="n">wookie</span><span class="o">.</span>
- <span class="n">This</span> <span class="n">file</span> <span class="n">usually</span> <span class="n">will</span> <span class="ow">not</span> <span class="n">need</span> <span class="n">to</span> <span class="n">be</span> <span class="n">updated</span> <span class="n">very</span> <span class="n">often</span><span class="p">,</span> <span class="n">but</span> <span class="n">as</span> <span class="n">it</span> <span class="n">points</span> <span class="n">to</span> <span class="n">other</span> <span class="n">files</span> <span class="ow">and</span> <span class="n">explains</span> <span class="n">some</span> <span class="n">of</span> <span class="n">the</span> <span class="n">different</span> <span class="n">builds</span><span class="p">,</span> <span class="n">it</span> <span class="n">should</span> <span class="n">be</span> <span class="n">checked</span> <span class="k">for</span> <span class="n">accuracy</span><span class="o">.</span>
- <span class="mi">2</span><span class="o">.</span> <span class="n">RELEASE_NOTES</span> <span class="o">-</span> <span class="n">this</span> <span class="n">must</span> <span class="n">be</span> <span class="n">updated</span> <span class="n">with</span> <span class="n">the</span> <span class="n">list</span> <span class="n">of</span> <span class="n">issues</span> <span class="n">addressed</span> <span class="n">since</span> <span class="n">the</span> <span class="k">last</span> <span class="n">release</span><span class="o">.</span>
- <span class="n">This</span> <span class="n">can</span> <span class="n">be</span> <span class="n">obtained</span> <span class="n">from</span> <span class="n">the</span> <span class="n">wookie</span> <span class="n">JIRA</span> <span class="n">by</span> <span class="n">selecting</span> <span class="n">all</span> <span class="n">issues</span> <span class="n">addressed</span> <span class="k">for</span> <span class="n">this</span> <span class="n">planned</span> <span class="n">version</span><span class="o">.</span>
- <span class="mi">3</span><span class="o">.</span> <span class="n">UPGRADING</span> <span class="o">-</span> <span class="n">this</span> <span class="n">must</span> <span class="n">be</span> <span class="n">updated</span> <span class="k">if</span> <span class="n">there</span> <span class="n">were</span> <span class="n">any</span> <span class="n">significant</span> <span class="n">changes</span> <span class="n">made</span> <span class="n">to</span> <span class="n">wookie</span> <span class="n">since</span> <span class="n">the</span> <span class="k">last</span> <span class="n">release</span><span class="o">.</span>
- <span class="n">Examples</span> <span class="n">of</span> <span class="n">this</span> <span class="n">are</span> <span class="o">-</span> <span class="n">changes</span> <span class="n">to</span> <span class="n">the</span> <span class="n">database</span> <span class="n">which</span> <span class="n">means</span> <span class="n">that</span> <span class="n">users</span> <span class="n">may</span> <span class="n">have</span> <span class="n">to</span> <span class="n">manually</span> <span class="n">migrate</span> <span class="n">data</span> <span class="n">using</span> <span class="n">scripts</span>
- <span class="ow">or</span> <span class="n">where</span> <span class="n">a</span> <span class="n">major</span> <span class="n">overhaul</span> <span class="n">of</span> <span class="n">the</span> <span class="n">user</span> <span class="n">interface</span> <span class="n">OR</span> <span class="n">API</span> <span class="n">means</span> <span class="n">users</span> <span class="n">would</span> <span class="n">have</span> <span class="n">to</span> <span class="n">change</span><span class="o">/</span><span class="n">update</span> <span class="n">their</span> <span class="n">current</span> <span class="n">practices</span> <span class="k">for</span> <span class="n">using</span> <span class="n">those</span> <span class="n">parts</span> <span class="n">of</span> <span class="n">wookie</span>
- <span class="mi">4</span><span class="o">.</span> <span class="n">NOTICE</span> <span class="o">-</span> <span class="n">this</span> <span class="n">should</span> <span class="n">be</span> <span class="n">checked</span> <span class="n">to</span> <span class="n">make</span> <span class="n">sure</span> <span class="n">any</span> <span class="k">new</span> <span class="n">components</span> <span class="n">added</span> <span class="n">to</span> <span class="n">wookie</span> <span class="n">since</span> <span class="n">the</span> <span class="k">last</span> <span class="n">release</span> <span class="n">are</span> <span class="n">mentioned</span><span class="o">.</span> <span class="n">Note:</span> <span class="n">the</span> <span class="n">actual</span> <span class="n">licences</span> <span class="k">for</span> <span class="n">these</span> <span class="n">go</span> <span class="n">into</span> <span class="n">the</span> <span class="n">LICENSE</span> <span class="n">file
</span><span class="o">.</span>
- <span class="mi">5</span><span class="o">.</span> <span class="n">NEW_AND_NOTEWORTHY</span> <span class="o">-</span> <span class="n">this</span> <span class="n">should</span> <span class="n">be</span> <span class="n">checked</span> <span class="ow">and</span> <span class="n">updated</span> <span class="n">to</span> <span class="n">point</span> <span class="n">out</span> <span class="ow">and</span> <span class="n">mention</span> <span class="n">any</span> <span class="k">new</span> <span class="n">features</span> <span class="n">in</span> <span class="n">wookie</span> <span class="n">since</span> <span class="n">the</span> <span class="k">last</span> <span class="n">release</span><span class="p">,</span> <span class="n">that</span> <span class="n">are</span> <span class="n">deemed</span> <span class="n">significant</span><span class="o">.</span>
- <span class="mi">6</span><span class="o">.</span> <span class="n">BUILDING</span> <span class="o">-</span> <span class="n">this</span> <span class="n">describes</span> <span class="n">how</span> <span class="n">to</span> <span class="n">build</span> <span class="n">wookie</span> <span class="n">from</span> <span class="n">the</span> <span class="n">source</span><span class="o">.</span> <span class="n">This</span> <span class="n">should</span> <span class="n">be</span> <span class="n">checked</span> <span class="k">for</span> <span class="n">accuracy</span><span class="p">,</span> <span class="n">but</span> <span class="n">will</span> <span class="n">probably</span> <span class="ow">not</span> <span class="n">change</span> <span class="n">very</span> <span class="n">often</span><span class="o">.</span>
- <span class="mi">7</span><span class="o">.</span> <span class="n">LICENSE</span> <span class="o">-</span> <span class="n">this</span> <span class="n">file</span> <span class="n">contains</span> <span class="n">references</span> <span class="n">to</span> <span class="n">all</span> <span class="n">the</span> <span class="n">licenses</span> <span class="n">of</span> <span class="n">the</span> <span class="n">third</span> <span class="n">party</span> <span class="ow">and</span> <span class="n">contributed</span> <span class="n">libaries</span> <span class="ow">and</span> <span class="n">code</span> <span class="n">used</span> <span class="n">in</span> <span class="n">wookie</span><span class="o">.</span>
- <span class="n">Any</span> <span class="k">new</span> <span class="n">libraries</span> <span class="ow">and</span> <span class="n">code</span> <span class="n">added</span> <span class="n">since</span> <span class="n">the</span> <span class="k">last</span> <span class="n">release</span> <span class="n">must</span> <span class="n">have</span> <span class="n">their</span> <span class="n">licences</span> <span class="n">added</span> <span class="n">here</span><span class="o">.</span> <span class="n">The</span> <span class="n">main</span> <span class="n">exception</span> <span class="n">here</span> <span class="n">is</span> <span class="n">an</span> <span class="n">existing</span> <span class="n">Apache</span> <span class="n">Software</span> <span class="n">Foundation</span> <span class="n">library</span><span class="p">,</span> <span class="n">which</span> <span class="n">does</span> <span class="ow">not</span> <span class="n">need</span> <span class="n">to</span> <span
class="n">be</span> <span class="n">included</span><span class="o">.</span>
-
- <span class="mi">2</span><span class="o">.</span> <span class="n">Check</span> <span class="n">the</span> <span class="n">licences</span> <span class="ow">and</span> <span class="n">notices</span> <span class="n">found</span> <span class="n">under</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/</span> <span class="p">(</span><span class="n">Note:</span> <span class="n">some</span> <span class="n">of</span> <span class="n">the</span> <span class="n">builds</span> <span class="n">have</span> <span class="n">specific</span> <span class="n">LICENCE</span> <span class="ow">and</span> <span class="n">NOTICE</span> <span class="n">files</span><span class="p">)</span>
- <span class="mi">1</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/m</span><span class="n">aven</span><span class="sr">/subprojects/</span><span class="n">LICENCE</span><span class="o">.</span> <span class="n">This</span> <span class="n">licence</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">all</span> <span class="n">the</span> <span class="n">maven</span> <span class="n">artifacts</span>
- <span class="p">(</span><span class="n">except</span> <span class="n">the</span> <span class="n">maven</span> <span class="n">WAR</span> <span class="n">artifact</span><span class="p">)</span> <span class="ow">and</span> <span class="n">should</span> <span class="n">only</span> <span class="n">contain</span> <span class="n">the</span> <span class="n">apache</span> <span class="n">license</span><span class="o">.</span> <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">in</span> <span class="n">in</span> <span class="n">the</span> <span class="o">/</span><span class="n">META</span><span class="o">-</span><span class="n">INF</span> <span class="n">folder</span> <span class="n">of</span> <span class="n">a</span> <span class="n">generated</span> <span class="o">.</span><span class="n">jar</span> <span class="n">file</span><span class="p">)</span>
- <span class="mi">2</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/m</span><span class="n">aven</span><span class="sr">/subprojects/</span><span class="n">NOTICE</span><span class="o">.</span> <span class="n">This</span> <span class="n">notice</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">all</span> <span class="n">the</span> <span class="n">maven</span> <span class="n">artifacts</span>
- <span class="p">(</span><span class="n">except</span> <span class="n">the</span> <span class="n">maven</span> <span class="n">WAR</span> <span class="n">artifact</span><span class="p">)</span> <span class="ow">and</span> <span class="n">should</span> <span class="n">only</span> <span class="n">contain</span> <span class="n">the</span> <span class="n">apache</span> <span class="n">license</span> <span class="n">references</span><span class="o">.</span> <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">in</span> <span class="n">in</span> <span class="n">the</span> <span class="o">/</span><span class="n">META</span><span class="o">-</span><span class="n">INF</span> <span class="n">folder</span> <span class="n">of</span> <span class="n">a</span> <span class="n">generated</span> <span class="o">.</span><span class="n">jar</span> <span class="n">file</span><span class="p">)</span>
- <span class="mi">3</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/m</span><span class="n">aven</span><span class="sr">/war/</span><span class="n">LICENSE</span><span class="o">.</span> <span class="n">This</span> <span class="n">license</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">the</span> <span class="n">maven</span> <span class="n">WAR</span> <span class="n">artifact</span> <span class="n">only</span><span class="o">.</span>
- <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">in</span> <span class="n">in</span> <span class="n">the</span> <span class="o">/</span><span class="n">META</span><span class="o">-</span><span class="n">INF</span> <span class="n">folder</span> <span class="n">of</span> <span class="n">a</span> <span class="n">generated</span> <span class="o">.</span><span class="n">war</span> <span class="n">file</span><span class="p">)</span><span class="o">.</span>
- <span class="mi">4</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/m</span><span class="n">aven</span><span class="sr">/war/</span><span class="n">NOTICE</span><span class="o">.</span> <span class="n">This</span> <span class="n">notice</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">the</span> <span class="n">maven</span> <span class="n">WAR</span> <span class="n">artifact</span> <span class="n">only</span><span class="o">.</span>
- <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">in</span> <span class="n">in</span> <span class="n">the</span> <span class="o">/</span><span class="n">META</span><span class="o">-</span><span class="n">INF</span> <span class="n">folder</span> <span class="n">of</span> <span class="n">a</span> <span class="n">generated</span> <span class="o">.</span><span class="n">war</span> <span class="n">file</span><span class="p">)</span><span class="o">.</span>
- <span class="mi">5</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/s</span><span class="n">tandalone</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">.</span> <span class="n">This</span> <span class="n">license</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">the</span> <span class="n">standalone</span> <span class="n">build</span> <span class="n">only</span><span class="o">.</span> <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">generated</span> <span class="n">standalone</span> <span class="n">build</span><span class="p">)</span>
- <span class="mi">6</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/s</span><span class="n">tandalone</span><span class="o">/</span><span class="n">NOTICE</span><span class="o">.</span> <span class="n">This</span> <span class="n">notice</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">the</span> <span class="n">standalone</span> <span class="n">build</span> <span class="n">only</span><span class="o">.</span> <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">generated</span> <span class="n">standalone</span> <span class="n">build</span><span class="p">)</span>
- <span class="mi">7</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/s</span><span class="n">tandalone</span><span class="o">/</span><span class="n">STANDALONE_BUILD_NOTES</span><span class="o">.</span> <span class="n">This</span> <span class="n">should</span> <span class="ow">not</span> <span class="n">change</span> <span class="n">very</span> <span class="n">often</span><span class="p">,</span> <span class="n">but</span> <span class="n">a</span> <span class="n">quick</span> <span class="nb">read</span> <span class="n">through</span> <span class="n">is</span> <span class="n">recommended</span> <span class="n">to</span> <span class="n">make</span> <span class="n">sure</span> <span class="n">nothing</span> <span class="n">has</span> <span class="n">changed</span><span class="o">.</span>
- <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">generated</span> <span class="n">standalone</span> <span class="n">build</span><span class="p">)</span>
- <span class="mi">8</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/</span><span class="n">war</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">.</span> <span class="n">This</span> <span class="n">license</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">the</span> <span class="n">war</span> <span class="n">build</span> <span class="n">only</span><span class="o">.</span> <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">generated</span> <span class="n">war</span> <span class="n">build</span><span class="p">)</span>
- <span class="mi">9</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/</span><span class="n">war</span><span class="o">/</span><span class="n">NOTICE</span><span class="o">.</span> <span class="n">This</span> <span class="n">notice</span> <span class="n">file</span> <span class="n">is</span> <span class="n">bundled</span> <span class="n">with</span> <span class="n">the</span> <span class="n">war</span> <span class="n">build</span> <span class="n">only</span><span class="o">.</span> <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">generated</span> <span class="n">war</span> <span class="n">build</span><span class="p">)</span>
- <span class="mi">10</span><span class="o">.</span> <span class="sr">/trunk/</span><span class="n">etc</span><span class="sr">/release/</span><span class="n">war</span><span class="o">/</span><span class="n">WAR_BUILD_NOTES</span><span class="o">.</span> <span class="n">This</span> <span class="n">should</span> <span class="ow">not</span> <span class="n">change</span> <span class="n">very</span> <span class="n">often</span><span class="p">,</span> <span class="n">but</span> <span class="n">a</span> <span class="n">quick</span> <span class="nb">read</span> <span class="n">through</span> <span class="n">is</span> <span class="n">recommended</span> <span class="n">to</span> <span class="n">make</span> <span class="n">sure</span> <span class="n">nothing</span> <span class="n">has</span> <span class="n">changed</span><span class="o">.</span>
- <span class="p">(</span><span class="n">It</span> <span class="n">is</span> <span class="n">found</span> <span class="n">at</span> <span class="n">the</span> <span class="n">root</span> <span class="n">of</span> <span class="n">the</span> <span class="n">generated</span> <span class="n">war</span> <span class="n">build</span><span class="p">)</span>
-</pre></div>
-
-
+<ol>
+<li>
+<p>Check the following files found at the root of the trunk. (They are bundled with all the builds, except in the case of LICENSE and NOTICE, which are build specific)</p>
+<ol>
+<li>README - this is usually the first file a user will read when they download either the source or binary versions of wookie.
+This file usually will not need to be updated very often, but as it points to other files and explains some of the different builds, it should be checked for accuracy.</li>
+<li>RELEASE_NOTES - this must be updated with the list of issues addressed since the last release.<br />
+This can be obtained from the wookie JIRA by selecting all issues addressed for this planned version.</li>
+<li>UPGRADING - this must be updated if there were any significant changes made to wookie since the last release.
+Examples of this are - changes to the database which means that users may have to manually migrate data using scripts or where a major overhaul of the user interface OR API means users would have to change/update their current practices for using those parts of wookie</li>
+<li>NOTICE - this should be checked to make sure any new components added to wookie since the last release are mentioned. Note: the actual licences for these go into the LICENSE file.</li>
+<li>NEW_AND_NOTEWORTHY - this should be checked and updated to point out and mention any new features in wookie since the last release, that are deemed significant.</li>
+<li>BUILDING - this describes how to build wookie from the source. This should be checked for accuracy, but will probably not change very often.</li>
+<li>LICENSE - this file contains references to all the licenses of the third party and contributed libaries and code used in wookie.<br />
+Any new libraries and code added since the last release must have their licences added here. The main exception here is an existing Apache Software Foundation library, which does not need to be included.</li>
+</ol>
+</li>
+<li>
+<p>Check the licences and notices found under /trunk/etc/release/ (Note: some of the builds have specific LICENCE and NOTICE files)</p>
+<ol>
+<li>/trunk/etc/release/maven/subprojects/LICENCE. This licence file is bundled with all the maven artifacts
+(except the maven WAR artifact) and should only contain the apache license. (It is found in in the /META-INF folder of a generated .jar file)</li>
+<li>/trunk/etc/release/maven/subprojects/NOTICE. This notice file is bundled with all the maven artifacts
+(except the maven WAR artifact) and should only contain the apache license references. (It is found in in the /META-INF folder of a generated .jar file)</li>
+<li>/trunk/etc/release/maven/war/LICENSE. This license file is bundled with the maven WAR artifact only.
+(It is found in in the /META-INF folder of a generated .war file).</li>
+<li>/trunk/etc/release/maven/war/NOTICE. This notice file is bundled with the maven WAR artifact only.
+(It is found in in the /META-INF folder of a generated .war file).</li>
+<li>/trunk/etc/release/standalone/LICENSE. This license file is bundled with the standalone build only. (It is found at the root of the generated standalone build)</li>
+<li>/trunk/etc/release/standalone/NOTICE. This notice file is bundled with the standalone build only. (It is found at the root of the generated standalone build)</li>
+<li>/trunk/etc/release/standalone/STANDALONE_BUILD_NOTES. This should not change very often, but a quick read through is recommended to make sure nothing has changed.
+ (It is found at the root of the generated standalone build)</li>
+<li>/trunk/etc/release/war/LICENSE. This license file is bundled with the war build only. (It is found at the root of the generated war build)</li>
+<li>/trunk/etc/release/war/NOTICE. This notice file is bundled with the war build only. (It is found at the root of the generated war build)</li>
+<li>/trunk/etc/release/war/WAR_BUILD_NOTES. This should not change very often, but a quick read through is recommended to make sure nothing has changed.
+(It is found at the root of the generated war build)</li>
+</ol>
+</li>
+</ol>
<h3 id="4-check-all-files-for-license-headers">4. Check all files for license headers</h3>
-<div class="codehilite"><pre><span class="n">Use</span> <span class="n">the</span> <span class="p">[</span><span class="n">Release</span> <span class="n">Audit</span> <span class="n">Tool</span> <span class="p">(</span><span class="n">RAT</span><span class="p">)](</span><span class="n">http:</span><span class="sr">//ci</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/projects/</span><span class="n">wookie</span><span class="o">/</span><span class="n">rat</span><span class="o">-</span><span class="n">output</span><span class="o">.</span><span class="n">html</span><span class="p">)</span> <span class="n">report</span> <span class="n">to</span> <span class="n">find</span> <span class="n">any</span> <span class="n">missing</span> <span class="n">license</span> <span class="n">headers</span><span class="o">.</span> <span class="n">Fix</span> <span class="n">any</span> <span class="n">missing</span> <spa
n class="n">entries</span><span class="o">.</span>
-</pre></div>
-
-
+<p>Use the <a href="http://ci.apache.org/projects/wookie/rat-output.html">Release Audit Tool (RAT)</a> report to find any missing license headers. Fix any missing entries.</p>
<h3 id="5-update-all-references-to-snapshot-in-the-properties-files-and-update-the-pom-templates">5. Update all references to SNAPSHOT in the properties files and update the pom-templates</h3>
-<div class="codehilite"><pre>1. Find the version reference '*.*.*-incubating-SNAPSHOT' in the following files. Update it in each case removing the '-SNAPSHOT' at the end, so that it reads '*.*.*-incubating'
-
-/build.properties
+<ol>
+<li>
+<p>Find the version reference '<em>.</em>.<em>-incubating-SNAPSHOT' in the following files. Update it in each case removing the '-SNAPSHOT' at the end, so that it reads '</em>.<em>.</em>-incubating'</p>
+<p>/build.properties
/ivy.xml
/connector/java/build.properties
/connector/java/ivy.xml
@@ -187,36 +189,31 @@ configuring it for tomcat/mysql but it a
/parser/java/build.properties
/parser/java/ivy.xml
/src/widgetserver.properties
-/etc/release/runsignatures.bat
-
-2. Update the 3 pom-template.xml files so that the scm values reference the tag version to be created
-
-/pom-template.xml
-
-Find...
-<span class="nt"><scm></span>
- <span class="nt"><connection></span>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/trunk<span class="nt"></connection></span>
- <span class="nt"><developerConnection></span>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/trunk/<span class="nt"></developerConnection></span>
- <span class="nt"><url></span>http://svn.apache.org/viewvc/incubator/wookie/trunk/<span class="nt"></url></span>
-<span class="nt"></scm></span>
-
-...and update it (with correct version number) to read...
-
-<span class="nt"><scm></span>
- <span class="nt"><connection></span>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating<span class="nt"></connection></span>
- <span class="nt"><developerConnection></span>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating/<span class="nt"></developerConnection></span>
- <span class="nt"><url></span>http://svn.apache.org/viewvc/incubator/wookie/tags/*.*.*-incubating/<span class="nt"></url></span>
-<span class="nt"></scm></span>
-
-Do the same with the following two files...
-
-/connector/java/pom-template.xml
-/parser/java/pom-template.xml
-
-3. Commit your changes back to svn.
-</pre></div>
-
-
+/etc/release/runsignatures.bat</p>
+</li>
+<li>
+<p>Update the 3 pom-template.xml files so that the scm values reference the tag version to be created</p>
+<p>/pom-template.xml</p>
+<p>Find...
+<scm>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/trunk</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/trunk/</developerConnection>
+ <url>http://svn.apache.org/viewvc/incubator/wookie/trunk/</url>
+</scm></p>
+<p>...and update it (with correct version number) to read...</p>
+<p><scm>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/tags/<em>.</em>.<em>-incubating</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/tags/</em>.<em>.</em>-incubating/</developerConnection>
+ <url>http://svn.apache.org/viewvc/incubator/wookie/tags/<em>.</em>.*-incubating/</url>
+</scm></p>
+<p>Do the same with the following two files...</p>
+<p>/connector/java/pom-template.xml
+/parser/java/pom-template.xml</p>
+</li>
+<li>
+<p>Commit your changes back to svn.</p>
+</li>
+</ol>
<h3 id="6-inform-committers-of-temporary-code-freeze">6. Inform committers of temporary code freeze</h3>
<div class="codehilite"><pre><span class="n">Send</span> <span class="n">an</span> <span class="n">email</span> <span class="n">to</span> <span class="n">wookie</span><span class="o">-</span><span class="n">dev</span><span class="nv">@incubator</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span> <span class="n">informing</span> <span class="n">that</span> <span class="n">you</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">tag</span> <span class="n">the</span> <span class="n">trunk</span><span class="o">.</span>
<span class="p">(</span><span class="n">just</span> <span class="n">in</span> <span class="k">case</span> <span class="n">there</span> <span class="n">are</span> <span class="n">commits</span> <span class="k">while</span> <span class="n">you</span> <span class="n">are</span> <span class="n">doing</span> <span class="n">it</span><span class="o">.</span> <span class="n">It</span> <span class="n">only</span> <span class="n">takes</span> <span class="n">a</span> <span class="n">minute</span> <span class="n">to</span> <span class="n">tag</span> <span class="n">it</span><span class="p">,</span> <span class="n">so</span> <span class="ow">not</span> <span class="n">a</span> <span class="n">long</span> <span class="n">freeze</span><span class="o">.</span><span class="p">)</span>