Author: psteitz
Date: Wed Mar 31 06:09:21 2010
New Revision: 929397
URL: http://svn.apache.org/viewvc?rev=929397&view=rev
Log:
Added start of a subsection on build configuration.
Modified:
commons/proper/commons-site/trunk/src/site/xdoc/releases/prepare.xml
Modified: commons/proper/commons-site/trunk/src/site/xdoc/releases/prepare.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-site/trunk/src/site/xdoc/releases/prepare.xml?rev=929397&r1=929396&r2=929397&view=diff
==============================================================================
--- commons/proper/commons-site/trunk/src/site/xdoc/releases/prepare.xml
(original)
+++ commons/proper/commons-site/trunk/src/site/xdoc/releases/prepare.xml Wed
Mar 31 06:09:21 2010
@@ -148,6 +148,31 @@
problems.
</p>
</subsection>
+ <subsection name='Configure the Build to Generate a Complete Set of
Release Artifacts'>
+ <p>
+ For builds using maven, the contents of the source and binary
distributions are configured
+ in assembly descriptors. By convention, these are stored in
src/main/assembly and named
+ src.xml and bin.xml, respectively. Names and locations for these files
are specified in
+ the maven-assembly-plugin configuration in the pom. Make sure that all
(and only) files
+ that should be included in the source and binary distributions are
included in the fileset
+ elements of the descriptors. Look at some recently released components'
descriptors for comparison.
+ At a minimum, both source and binary distributions <strong>must</strong>
include the release notes, license and
+ notice files.
+ </p>
+ <!-- TODO: add a paragraph on commons properties in the pom -->
+ <p>
+ When using Ant, typically the Ant dist goal produces the source and
binary distributions. Included
+ files are specified in the goal or subgoals and should be verified
similarly to above.
+ </p>
+ <p>
+ Test the "Ant dist" or "mvn assembly:assembly" goal and inspect the
tars/zips and jars produced.
+ "Ant dist" or "mvn site" should succeed from the unpacked source
distribution. Make sure it does.
+ Check the jar manifests per the guidelines below. Check the build using
the minimum supported JDK.
+ Check that "mvn site" generates the documentation correctly. Check that
all links are working.
+ Do not proceed with tagging or cutting RCs until you have a fully
working build that produces
+ a good set of distribution artifacts.
+ </p>
+ </subsection>
<subsection name='Check Class File Format'>
<p>
Unless appropriate options are set, code compiled with more modern JVMs
@@ -174,12 +199,6 @@
values must be overridden in the project's POM if they're not appropriate
for it.
</p>
</subsection>
- <subsection name='Check Documentation'>
- <p>
- Check that the documentation has been generated correctly. Check that all
links are working.
- </p>
- </subsection>
- <!-- TODO: add a subsection on commons properties in the pom and assembly
descriptors -->
</section>
<section name="Creating a Release Candidate">
