Author: psteitz
Date: Sat Dec 3 21:00:47 2005
New Revision: 353815
URL: http://svn.apache.org/viewcvs?rev=353815&view=rev
Log:
Several fixes to building and release docs:
* Included instructions for updating xdoc plugin.
* Replaced obsolete <id> elements with <groupId> throughout examples.
* Changed -dev to -SNAPSHOT.
* Fixed some typos.
BZ #37772
Contributed by Dennis Lundberg
Modified:
jakarta/commons/proper/commons-build/trunk/project.xml.sample
jakarta/commons/proper/commons-build/trunk/xdocs/building.xml
jakarta/commons/proper/commons-build/trunk/xdocs/releases/release.xml
Modified: jakarta/commons/proper/commons-build/trunk/project.xml.sample
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/commons-build/trunk/project.xml.sample?rev=353815&r1=353814&r2=353815&view=diff
==============================================================================
--- jakarta/commons/proper/commons-build/trunk/project.xml.sample (original)
+++ jakarta/commons/proper/commons-build/trunk/project.xml.sample Sat Dec 3
21:00:47 2005
@@ -20,7 +20,8 @@
<project>
<pomVersion>3</pomVersion>
<name>Foo</name>
- <id>commons-foo</id>
+ <groupId>commons-foo</groupId>
+ <artifactId>commons-foo</artifactId>
<currentVersion>1.0</currentVersion>
<inceptionYear>2005</inceptionYear>
<shortDescription>Jakarta Commons Foo</shortDescription>
Modified: jakarta/commons/proper/commons-build/trunk/xdocs/building.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/commons-build/trunk/xdocs/building.xml?rev=353815&r1=353814&r2=353815&view=diff
==============================================================================
--- jakarta/commons/proper/commons-build/trunk/xdocs/building.xml (original)
+++ jakarta/commons/proper/commons-build/trunk/xdocs/building.xml Sat Dec 3
21:00:47 2005
@@ -42,7 +42,7 @@
<p>
Some knowledge of maven is assumed in this document. Please refer to the
<a href="http://maven.apache.org/using/index.html";>maven user guide</a> and
- <a href="http://maven.apache.org/reference/index.html";>reference</a>
+ <a
href="http://maven.apache.org/maven-1.x/reference/index.html";>reference</a>
for more information. Most commons components now use version 1 of maven,
so this is the maven version assumed throughout this document. Updates
covering maven 2 are welcome!
@@ -60,9 +60,23 @@
<p>
Follow the
<a href="http://maven.apache.org/start/download.html";>
- maven download instructions</a> to download and install maven. Be sure
- to follow the instructions for upgrading the plugins to the latest
- releases.
+ maven download instructions</a> to download and install maven. You will
+ need Maven version 1.0.2.
+ </p>
+ <p>
+ You need the maven-xdoc-plugin version 1.9.2 to build a Jakarta Commons
+ web site. If you don't have that version, you need to upgrade. To
+ automatically install the plugin, type the following on a single line:
+ <source>
+ maven plugin:download
+
-Dmaven.repo.remote=http://www.ibiblio.org/maven,http://cvs.apache.org/repository/
+ -DgroupId=maven
+ -DartifactId=maven-xdoc-plugin
+ -Dversion=1.9.2
+ </source>
+ For a manual installation, you can download the plugin here:
+ <a
href="http://www.apache.org/dyn/closer.cgi/java-repository/maven/plugins/maven-xdoc-plugin-1.9.2.jar";>
+
http://www.apache.org/dyn/closer.cgi/java-repository/maven/plugins/maven-xdoc-plugin-1.9.2.jar</a>
</p>
</subsection>
<subsection name='Checking out the commons sources'>
@@ -84,7 +98,7 @@
avoided. There are a few things, however, that are specific to individual
developers that may need to be set locally. Generally, only committers
need to set local properties. As documented in the
- <a href="http://maven.apache.org/reference/properties.html";>
+ <a href="http://maven.apache.org/maven-1.x/reference/properties.html";>
maven properties reference</a>, maven looks for property values first in
<code>project.properties</code> in the project's base directory (where
<code>project.xml</code> lives), then in <code>build.properties</code> if
@@ -93,7 +107,7 @@
they occur in multiple places in this list.
</p>
<p>
- It may be convenient for committers running unix systems to set the
+ It may be convenient for committers to set the
following properties in ${user.home}/build.properties, which will make
them apply to all maven projects that they work on.
<pre>
@@ -125,17 +139,21 @@
(value to replace)</th></tr>
<tr><td>name</td><td>The capitalized name of the component</td>
<td>Foo</td></tr>
- <tr><td>id</td><td>commons-component (where "component" is the
+ <tr><td>groupId</td><td>commons-component (where "component" is the
+ uncapitalized name of the component)</td><td>commons-foo</td></tr>
+ <tr><td>artifactId</td><td>commons-component (where "component" is the
uncapitalized name of the component)</td><td>commons-foo</td></tr>
- <tr><td>currentVersion</td><td>current version under development</td>
- <td>1.0</td></tr>
- <tr><td>inceptionYear</td><td>year when the component was created</td>
+ <tr><td>currentVersion</td><td>Current version under development.
+ Development versions should always use the suffix "-SNAPSHOT".
+ Maven handles these SNAPSHOTs in a special way.</td>
+ <td>1.0-SNAPSHOT</td></tr>
+ <tr><td>inceptionYear</td><td>Year when the component was created</td>
<td>2005</td></tr>
<tr><td>shortDescription</td><td>Jakarta Commons <capitalized name>
</td><td>Jakarta Commons Foo</td></tr>
<tr><td>description</td><td><strong>Brief</strong> description of what
the component is</td><td>A Foo thing</td></tr>
- <tr><td>logo</td><td>path to component logo image</td>
+ <tr><td>logo</td><td>Path to component logo image</td>
<td>/images/logo.png</td></tr>
</table>
</p>
@@ -160,7 +178,7 @@
that you have the correct spelling of contributors' names and do not
include email addresses unless contributors specifically authorize this.
</td></tr>
- <tr><td>dependencies</td><td>minimize these ;-) and group them with
+ <tr><td>dependencies</td><td>Minimize these ;-) and group them with
comments designating them as compile-time, run-time and test-only if
these distinctions apply.</td></tr>
<tr><td>build</td><td>The sample file assumes the standard directory
@@ -175,7 +193,7 @@
<code>maven-changes-plugin</code> should only be used if the component
maintains a <code>changes.xml</code> file in <code>/xdocs</code>
following the format described in the
- <a href="http://maven.apache.org/reference/plugins/changes/";>
+ <a href="http://maven.apache.org/maven-1.x/reference/plugins/changes/";>
maven changes plugin documentation</a></td></tr></table>
</p>
</subsection>
@@ -231,7 +249,7 @@
following conditions need to be satisfied: <ol>
<li> The <code><siteAddress></code> and
<code><siteDirectory></code> POM elements have to have the values
- <code>cvs.apache.org</code> and
+ <code>people.apache.org</code> and
<code>/www/jakarta.apache.org/commons/foo/</code> respectively (will be the
case if you do not change the settings in <code>project.xml.sample.</code>)
</li>
@@ -242,7 +260,7 @@
apache cvs info page</a> to get this set up correctly.</li></ol>
Assuming the second condition above is met, you can also deploy sites
manually using scp or by tarring / zipping and extracting the content
- to the path above on <code>cvs.apache.org.</code> In either case,
+ to the path above on <code>people.apache.org.</code> In either case,
The content will be rsynced within a few hours to the production
web server(s). Note that because of the rsync delay,
<strong>your changes will not appear immediately on the live site.</strong>
@@ -275,7 +293,7 @@
<td>deployment location for <strong>released</strong> apache jars.
Should not be accessed for dependency resolution by maven builds.
Contents
are rsynced to ibiblio.</td></tr>
- <tr><td>http://www.ibiblio.org</td>
+ <tr><td>http://www.ibiblio.org/maven/</td>
<td>Default remote repository used by maven. Apache release jars are
rsynced every few hours from java-repository to this
repository.</td></tr>
</table>
@@ -313,14 +331,14 @@
</ul>
As stated in the
<a href="http://jakarta.apache.org/commons/releases/release.html";>
- release instructions</a>, please make sure to update the artifact id to
- end in <code>-dev</code> after pushing out the release jar.
+ release instructions</a>, please make sure to update the currentVersion
to
+ end in <code>-SNAPSHOT</code> after pushing out the release jar.
</p>
</subsection>
<subsection name='Deploying snapshot jars'>
<p>
Assuming the setup in <code>project.properties.sample</code>, and
- correctly set artifact id (should end in <code>-dev</code> or
+ correctly set currectVersion (should end in
<code>-SNAPSHOT</code>) the following command can be used to deploy a
"snapshot" or "development build" jar to the apache snapshot repository:
<source>maven jar:deploy-snapshot</source>
@@ -331,7 +349,7 @@
<p>
To customize the behavior of maven builds, jelly-script can be added to
<code>maven.xml</code> The
- <a href="http://maven.apache.org/reference/scripting.html";>maven scripting
+ <a href="http://maven.apache.org/maven-1.x/reference/scripting.html";>maven
scripting
reference</a> provides details and examples. For ease of maintanance and
to make upgrades easier, scripting should be kept to an absolute minimum.
If a plugin does not quite do what we need, it is better to try to get the
Modified: jakarta/commons/proper/commons-build/trunk/xdocs/releases/release.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/commons-build/trunk/xdocs/releases/release.xml?rev=353815&r1=353814&r2=353815&view=diff
==============================================================================
--- jakarta/commons/proper/commons-build/trunk/xdocs/releases/release.xml
(original)
+++ jakarta/commons/proper/commons-build/trunk/xdocs/releases/release.xml Sat
Dec 3 21:00:47 2005
@@ -574,6 +574,11 @@
Update build number found in <code>build.xml</code> in the trunk. This
should be
updated to a <code>dev</code> release, eg change "1.2" to "1.3-dev"
</li>
+ <li>
+ <strong>Update currentVersion</strong>
+ Update currentVersion found in <code>project.xml</code> in the trunk. This
should be
+ updated to a <code>SNAPSHOT</code> release, eg change "1.2" to
"1.3-SNAPSHOT"
+ </li>
</ul>
</subsection>
@@ -584,7 +589,7 @@
please contact Martin van den Bemt (mvdb at apache.org).
</p>
<p>
- Now is also an idea time to have a go at fixing some of those bugs you
marked as <code>LATER</code>.
+ Now is also an ideal time to have a go at fixing some of those bugs you
marked as <code>LATER</code>.
</p>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
