maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r841370 [17/47] - in /websites/staging/maven/trunk/content: ./ ant/ background/ css/ developers/ developers/conventions/ developers/release/ developers/website/ docs/ docs/2.0.1/ docs/2.0.10/ docs/2.0.11/ docs/2.0.2/ docs/2.0.3/ docs/2.0.4/...
Date Mon, 10 Dec 2012 08:17:44 GMT
Added: websites/staging/maven/trunk/content/guides/development/guide-plugin-documentation.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-plugin-documentation.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-plugin-documentation.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,423 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>Maven - Guide to the Plugin Documentation Standard</title>
+    <style type="text/css" media="all">
+      @import url("../../css/maven-base.css");
+      @import url("../../css/maven-theme.css");
+      @import url("../../css/site.css");
+    </style>
+    <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+        <meta name="author" content="Maven Team" />
+        <meta name="Date-Revision-yyyymmdd" content="20121210" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+                                                    
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+                                                        
+<script type="text/javascript">_uacct = "UA-140879-1";
+        urchinTracker();</script>
+                              </head>
+  <body class="composite">
+    <div id="banner">
+                                      <a href="../.././" id="bannerLeft">
+                                                <img src="../../images/apache-maven-project-2.png" alt="" />
+                </a>
+                        <span id="bannerRight">
+                                                <img src="../../images/maven-logo-2.gif" alt="" />
+                </span>
+            <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="breadcrumbs">
+            
+                                   <div class="xleft">
+                          <a href="http://www.apache.org/" class="externalLink">Apache</a>
+        &gt;
+                  <a href="../../index.html">Maven</a>
+        &gt;
+        Guide to the Plugin Documentation Standard
+        </div>
+            <div class="xright">        
+                                    Last Published: 2012-12-10
+            </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="leftColumn">
+      <div id="navcolumn">
+             
+                                                   <h5>Main</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../index.html">Welcome</a>
+            </li>
+          </ul>
+                       <h5>Get Maven</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../download.html">Download</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../license.html">License</a>
+            </li>
+          </ul>
+                       <h5>IDE Integration</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../eclipse-plugin.html">Eclipse</a>
+            </li>
+                  <li class="none">
+                  <a href="../../netbeans-module.html">NetBeans</a>
+            </li>
+          </ul>
+                       <h5>About Maven</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../what-is-maven.html">What is Maven?</a>
+            </li>
+                  <li class="none">
+                  <a href="../../maven-features.html">Features</a>
+            </li>
+                  <li class="none">
+                  <a href="../../general.html">FAQ (official)</a>
+            </li>
+                  <li class="none">
+                  <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+            </li>
+          </ul>
+                       <h5>Documentation</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../plugins/index.html">Maven Plugins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/index.html">Index (category)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../run-maven/index.html">Running Maven</a>
+            </li>
+                                                                                                                                            <li class="collapsed">
+                  <a href="../../users/index.html">User Centre</a>
+                  </li>
+                                                                                                        <li class="collapsed">
+                  <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+                  </li>
+                  <li class="none">
+                  <a href="../../repository/index.html">Maven Repository Centre</a>
+            </li>
+                  <li class="none">
+                  <a href="../../developers/index.html">Maven Developer Centre</a>
+            </li>
+                  <li class="none">
+                  <a href="../../articles.html">Books and Resources</a>
+            </li>
+                  <li class="none">
+                  <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+            </li>
+          </ul>
+                       <h5>Community</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../community.html">Community Overview</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+            </li>
+                  <li class="none">
+                  <a href="../../users/getting-help.html">Getting Help</a>
+            </li>
+                  <li class="none">
+                  <a href="../../issue-tracking.html">Issue Tracking</a>
+            </li>
+                  <li class="none">
+                  <a href="../../source-repository.html">Source Repository</a>
+            </li>
+                  <li class="none">
+                  <a href="../../team-list.html">The Maven Team</a>
+            </li>
+          </ul>
+                       <h5>Project Documentation</h5>
+                  <ul>
+                                                                                                                          <li class="collapsed">
+                  <a href="../../project-info.html">Project Information</a>
+                  </li>
+          </ul>
+                       <h5>Maven Projects</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../ant-tasks/index.html">Ant Tasks</a>
+            </li>
+                  <li class="none">
+                  <a href="../../archetype/index.html">Archetype</a>
+            </li>
+                  <li class="none">
+                  <a href="../../doxia/index.html">Doxia</a>
+            </li>
+                  <li class="none">
+                  <a href="../../jxr/index.html">JXR</a>
+            </li>
+                  <li class="none">
+                  <a href="../../maven-1.x/index.html">Maven 1.x</a>
+            </li>
+                  <li class="none">
+                  <a href="../../index.html">Maven 2 & 3</a>
+            </li>
+                  <li class="none">
+                  <a href="../../pom/index.html">Parent POMs</a>
+            </li>
+                  <li class="none">
+                  <a href="../../plugins/index.html">Plugins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../plugin-tools/index.html">Plugin Tools</a>
+            </li>
+                  <li class="none">
+                  <a href="../../scm/index.html">SCM</a>
+            </li>
+                  <li class="none">
+                  <a href="../../shared/index.html">Shared Components</a>
+            </li>
+                  <li class="none">
+                  <a href="../../skins/index.html">Skins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../surefire/index.html">Surefire</a>
+            </li>
+                  <li class="none">
+                  <a href="../../wagon/index.html">Wagon</a>
+            </li>
+          </ul>
+                       <h5>ASF</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+            </li>
+          </ul>
+                                 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+          <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+        </a>
+                       
+                               </div>
+    </div>
+    <div id="bodyColumn">
+      <div id="contentBox">
+        <div class="section"><h2>Introduction<a name="Introduction"></a></h2><div class="section"><h3>Where did the standard came from?<a name="Where_did_the_standard_came_from"></a></h3><p>The plugin documentation standard was created to address the frequent complain of lack of documentation, specifically on the Maven plugins. The standard was based on the suggestions made on the Maven dev mailing list with some refinements. It is a community consensus of what basic documentation a Maven plugin should have. </p></div><div class="section"><h3>Why do we need a documentation standard?<a name="Why_do_we_need_a_documentation_standard"></a></h3><p>The standard is not a set of rules but a guide to help plugin developers document their plugins better, for the benefit of the users of the plugin. The standard also reminds the plugin developers of the important details that needs to be documented, to help speed up the adoption of the plugin.</p></div></div><div class="section"><h2>Gen
 erated Documentation <a name="Generated_Documentation"></a></h2><p>It is recommended that you let Maven generate the basic information for the plugin to make sure that that the basic information is always accurate and synchronized with the plugin implementation. </p><p>Documentation is generated by running </p><div class="source"><pre>mvn site</pre></div><p>It will generate a plugin site based on the information in the POM, <tt>src/site</tt> and other reporting plugins configured in the POM. The most important reporting plugin is the <a class="externalLink" href="http://maven.apache.org/plugins/maven-plugin-plugin/">Maven Plugin Plugin</a> which will generate the documentation for each plugin goal based on the mojo annotations. But in order for the generated site to be usable, the required information should be available to the Maven Site Plugin.</p><div class="section"><h3>POM Elements<a name="POM_Elements"></a></h3><p>Maven extracts the information from the POM to generate
  the pages under Project Information. The first step in having a good documentation is to have an accurate and visible basic project information, Maven can provide this for the plugin as long as the information in the POM is complete, descriptive and accurate.</p><div class="section"><h4>Required Elements<a name="Required_Elements"></a></h4><p>Minimum elements for a valid POM:</p><ul><li><tt>&lt;modelVersion&gt;</tt> - POM model version, currently 4.0.0</li><li><tt>&lt;groupId&gt;</tt> - the package name</li><li><tt>&lt;artifactId&gt;</tt> - artifact name</li><li><tt>&lt;packaging&gt;</tt> - type of artifact produced by the POM</li><li><tt>&lt;version&gt;</tt> - the plugin version</li></ul></div><div class="section"><h4>Optional Elements <a name="Optional_Elements"></a></h4><p>These might be optional elements in a valid POM but they are important basic project information required by the users to effectively use the plugin:</p><ul><li><tt>&lt;name&gt;</tt> - plugin's name, <
 i>Maven NNN Plugin</i> for plugins hosted at the Maven project or <i>NNN Maven Plugin</i> for all others</li><li><tt>&lt;description&gt;</tt> - project description, an overview of what the plugin can do</li><li><tt>&lt;url&gt;</tt> - the site of the plugin, normally <i>maven.apache.org</i> or <i>mojo.codehaus.org</i></li><li><tt>&lt;prerequisites&gt;</tt> - the minimum version of Maven required to use this plugin</li><li><tt>&lt;issueManagement&gt;</tt> - describes the system used for reporting problems and modification requests<div class="source"><pre>  [...]
+  &lt;issueManagement&gt;
+    &lt;system&gt;jira&lt;/system&gt;
+    &lt;url&gt;http://jira.someproject.org&lt;/url&gt;
+  &lt;/issueManagement&gt;    
+  [...] </pre></div></li><li><tt>&lt;inceptionYear&gt;</tt> - year the plugin was first created</li><li><tt>&lt;mailingLists&gt;</tt> - lists where other users or the developers can be contacted for help and discussions<div class="source"><pre>  [...]
+  &lt;mailingLists&gt;
+    &lt;mailingList&gt;
+      &lt;name&gt;Project users&lt;/name&gt;
+      &lt;post&gt;announce@noonecares.com&lt;/post&gt;
+      &lt;subscribe&gt;users-subscribe@noonecares.com&lt;/subscribe&gt;
+      &lt;unsubscribe&gt;users-unsubscribe@noonecares.com&lt;/unsubscribe&gt;
+      &lt;archive&gt;http://noonecares.archive.org&lt;/archive&gt;
+    &lt;/mailingList&gt;    
+    &lt;mailingList&gt;
+      [...]
+    &lt;/mailingList&gt;
+  &lt;/mailingLists&gt;    
+  [...] </pre></div></li><li><tt>&lt;licenses&gt;</tt> - plugin license<div class="source"><pre>  [...]
+  &lt;licenses&gt;
+    &lt;license&gt;
+      &lt;name&gt;The Apache Software License, Version 2.0&lt;/name&gt;
+      &lt;url&gt;http://www.apache.org/licenses/LICENSE-2.0.txt&lt;/url&gt;
+      &lt;distribution&gt;repo&lt;/distribution&gt;
+    &lt;/license&gt;
+  &lt;/licenses&gt;
+  [...]</pre></div></li><li><tt>&lt;scm&gt;</tt> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS<div class="source"><pre>  [...]
+  &lt;scm&gt;
+    &lt;connection&gt;scm:svn:http://noonecares.com/some/plugin/project/trunk&lt;/connection&gt;
+    &lt;developerConnection&gt;scm:svn:https://noonecares.com/some/plugin/project/trunk&lt;/developerConnection&gt;
+    &lt;url&gt;http://noonecares.com/viewvc/some/project/trunk/&lt;/url&gt;
+  &lt;/scm&gt;
+  [...]</pre></div></li><li><tt>&lt;organization&gt;</tt> - the organization maintaining the plugin, just in case we need someone to blame<div class="source"><pre>  [...]
+  &lt;organization&gt;
+    &lt;name&gt;Noone Care Software Foundation&lt;/name&gt;
+    &lt;url&gt;http://noonecare.org/&lt;/url&gt;
+  &lt;/organization&gt; 
+  [...]</pre></div></li></ul></div></div><div class="section"><h3>Plugin Configuration Parameters<a name="Plugin_Configuration_Parameters"></a></h3><p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <tt>&lt;reporting&gt;</tt> section unless it is already inherited from a parent POM:</p><div class="source"><pre>  [...]
+  &lt;reporting&gt;
+    &lt;plugins&gt;
+      &lt;plugin&gt;
+        &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
+        &lt;artifactId&gt;maven-plugin-plugin&lt;/artifactId&gt;
+        &lt;version&gt;2.5.1&lt;/version&gt;
+      &lt;/plugin&gt;
+    &lt;/plugins&gt;
+  &lt;/reporting&gt;    
+  [...]  </pre></div><p>The comments, annotations and plugin parameter names are extracted from the plugin source and rendered in the Plugin Info page. In order for the generated site to be useful here are some guidelines you can follow when documenting your plugin.</p><ul><li>all <tt>@parameter</tt> fields should have a descriptive comment, informative enough that even a regular user can understand<div class="source"><pre>    [...]
+    /**
+     * Put something informative here that a regular user can understand.
+     * 
+     * @parameter 
+     */
+    private boolean someparameter;
+    [...]</pre></div></li><li>class level comment should explain what the goal does<div class="source"><pre>[...]
+/**
+ * Everything here will show up on the top of the generated plugin info page.
+ *
+ * @goal somegoal
+ * @phase compile
+ */
+public class ExampleMojo
+    extends AbstractWarMojo
+{
+    public void execute()
+        throws MojoExecutionException, MojoFailureException
+    {  
+[...]</pre></div></li><li>the <tt>@component</tt> and <tt>@readonly</tt> parameters are not required to have any comments but it's still a good practice to provide one</li></ul></div><div class="section"><h3>Site Organization <a name="Site_Organization"></a></h3><p>Visibility of the information is also crucial, having uniform navigation links will greatly improve the visibility of the documentations. The index page can also help emphasize important sections and pages of the plugin documentation. </p><div class="section"><h4>Site Descriptor <a name="Site_Descriptor"></a></h4><p>The site descriptor describes the navigation links and can be found in <tt>src/site/site.xml</tt>. Below is the suggested site descriptor template.</p><div class="source"><pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;project&gt;
+  &lt;body&gt;
+    &lt;menu name=&quot;Overview&quot;&gt;
+      &lt;item name=&quot;Introduction&quot; href=&quot;index.html&quot;/&gt;
+      &lt;item name=&quot;Goals&quot; href=&quot;plugin-info.html&quot;/&gt;
+      &lt;item name=&quot;Usage&quot; href=&quot;usage.html&quot;/&gt;
+      &lt;item name=&quot;FAQ&quot; href=&quot;faq.html&quot;/&gt;
+    &lt;/menu&gt;
+   
+    &lt;menu name=&quot;Examples&quot;&gt;
+      &lt;item name=&quot;description1&quot; href=&quot;examples/example-one.html&quot;/&gt;
+      &lt;item name=&quot;description2&quot; href=&quot;examples/example-two.html&quot;/&gt;
+    &lt;/menu&gt;
+  &lt;/body&gt;
+&lt;/project&gt;</pre></div><div class="section"><h5>Navigation Links<a name="Navigation_Links"></a></h5><ul><li>Introduction<p>The introduction is the front page of the plugin documentation. This is a good place to place any section and pages that needs to be emphasized. It is also suggested that the generated plugin parameter configuration be linked here. Below is the suggested <tt>src/site/apt/index.apt</tt> template</p><div class="source"><pre> ------
+ Introduction
+ ------
+ Author
+ ------
+ YYYY-MM-DD
+ ------
+
+
+Plugin Name
+
+  Plugin introduction, description, and other relevant information.
+
+* Goals Overview
+
+  General information about the goals.
+
+  * {{{&lt;goal&gt;.html}prefix:goal}} short description for this plugin goal.
+
+* Usage
+
+  General instructions on how to use the Plugin Name can be found on the {{{usage.html}usage page}}. Some more
+  specific use cases are described in the examples given below. Last but not least, users occasionally contribute
+  additional examples, tips or errata to the
+  {{{http://docs.codehaus.org/display/MAVENUSER/Plugin+Name}plugin's wiki page}}.
+
+  In case you still have questions regarding the plugin's usage, please have a look at the {{{faq.html}FAQ}} and feel
+  free to contact the {{{mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
+  already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
+  the {{{mail-lists.html}mail archive}}.
+
+  If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
+  {{{issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
+  concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
+  entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
+  Of course, patches are welcome, too. Contributors can check out the project from our
+  {{{source-repository.html}source repository}} and will find supplementary information in the
+  {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. 
+
+* Examples
+
+  To provide you with better understanding of some usages of the Plugin Name,
+  you can take a look into the following examples:
+
+  * {{{examples/example-one.html}Example Description One}}
+
+  * {{{examples/example-two.html}Example Description Two}}
+ </pre></div></li><li>Goals<p><tt>plugin-info.html</tt> is generated by the Maven Plugin Plugin. Until the Maven Site Plugin is updated it would be better to pull it out to the main menu for greater visibility. This contains the goals and their descriptions with a link to the configuration parameters. The information is based on the comments and annotations of the plugin. </p></li><li>Usage (this was previously called Howto)<p>The usage page describes the the basic use cases for the plugin goals which includes sample POM configurations and explanation of how the goals work. </p></li><li>FAQ<p>A well documented project always collates frequently asked questions which are usually located in <tt>src/site/fml/faq.fml</tt>. The example below provides a template for your FAQ:</p><div class="source"><pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;faqs id=&quot;FAQ&quot; title=&quot;Frequently Asked Questions&quot;&gt;
+  &lt;part id=&quot;General&quot;&gt;
+    &lt;faq id=&quot;question&quot;&gt;
+      &lt;question&gt;Question?&lt;/question&gt;
+      &lt;answer&gt;
+        &lt;p&gt;
+          Answer
+        &lt;/p&gt;
+      &lt;/answer&gt;
+    &lt;/faq&gt;
+  &lt;/part&gt;
+&lt;/faqs&gt;</pre></div></li><li>Examples<p>The advanced configurations and examples not covered in the usage page is located here. Advanced users who wants to maximize the use of a plugin can check the items here. Tips on how to use the plugin effectively is also a good thing to put here.</p><p>For examples of items under &quot;Examples&quot; check these plugin sites:</p><ul><li><a class="externalLink" href="http://maven.apache.org/plugins/maven-javadoc-plugin/">Maven Javadoc Plugin Examples</a></li><li><a class="externalLink" href="http://maven.apache.org/plugins/maven-war-plugin/">Maven War Plugin Examples</a></li></ul></li></ul></div></div></div><div class="section"><h3>Recommended Configured Reports<a name="Recommended_Configured_Reports"></a></h3><p>There are 2 recommended report plugins to enhance the plugin documentation, Javadoc and JXR.</p><ul><li>Maven Javadoc Plugin<p>Javadocs provide documentation that makes it easier for developers to know how to use a particu
 lar class. Instead of reading and understanding the actual source code, the developer can use the Javadocs instead to lookup the class attributes and methods.</p><p>To enable javadoc for your plugin add the following to your <tt>pom.xml</tt></p><div class="source"><pre>  [...]
+  &lt;build&gt;
+    [...]
+  &lt;/build&gt;
+  &lt;reporting&gt;
+    &lt;plugins&gt;
+      &lt;plugin&gt;
+        &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
+        &lt;artifactId&gt;maven-javadoc-plugin&lt;/artifactId&gt;
+        &lt;version&gt;2.4&lt;/version&gt;
+        &lt;configuration&gt;
+          &lt;minmemory&gt;128m&lt;/minmemory&gt;
+          &lt;maxmemory&gt;512&lt;/maxmemory&gt;
+          ...
+        &lt;/configuration&gt;
+      &lt;/plugin&gt;
+    &lt;/plugins&gt;
+    [...]
+  &lt;/reporting&gt;   
+  [...]</pre></div><p>Check the documentation about the plugin's <a class="externalLink" href="http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html"><tt>javadoc:javadoc</tt></a> goal for the advanced configurations.</p></li><li>Maven JXR Plugin<p>The Maven JXR Plugin generates a cross-reference of the project sources. The generated cross-references are also linked to the corresponding javadoc if javadoc is generated. The cross-references is great for those who wants to better understand the inner workings of the plugin.</p><p>To enable source code cross-references add the following to your <tt>pom.xml</tt></p><div class="source"><pre>  [...]
+  &lt;build&gt;
+    [...]
+  &lt;/build&gt;
+  &lt;reporting&gt;
+    &lt;plugins&gt;
+      &lt;plugin&gt;
+        &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
+        &lt;artifactId&gt;maven-jxr-plugin&lt;/artifactId&gt;
+        &lt;version&gt;2.1&lt;/version&gt;
+      &lt;/plugin&gt;
+    &lt;/plugins&gt;
+  &lt;/reporting&gt;    
+  [...]  </pre></div><p>Check the <a class="externalLink" href="http://maven.apache.org/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></li></ul></div></div>
+      </div>
+    </div>
+    <div class="clear">
+      <hr/>
+    </div>
+    <div id="footer">
+      <div class="xright">
+        &#169;            2002-2012
+              The Apache Software Foundation
+            
+                          - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+        Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+      </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+  </body>
+</html>

Added: websites/staging/maven/trunk/content/guides/development/guide-testing-development-plugins.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-testing-development-plugins.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-testing-development-plugins.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,298 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>Maven - Guide to Testing Development Versions of Plugins</title>
+    <style type="text/css" media="all">
+      @import url("../../css/maven-base.css");
+      @import url("../../css/maven-theme.css");
+      @import url("../../css/site.css");
+    </style>
+    <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+        <meta name="author" content="Brett Porter" />
+        <meta name="Date-Creation-yyyymmdd" content="20090802" />
+    <meta name="Date-Revision-yyyymmdd" content="20121210" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+                                                    
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+                                                        
+<script type="text/javascript">_uacct = "UA-140879-1";
+        urchinTracker();</script>
+                              </head>
+  <body class="composite">
+    <div id="banner">
+                                      <a href="../.././" id="bannerLeft">
+                                                <img src="../../images/apache-maven-project-2.png" alt="" />
+                </a>
+                        <span id="bannerRight">
+                                                <img src="../../images/maven-logo-2.gif" alt="" />
+                </span>
+            <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="breadcrumbs">
+            
+                                   <div class="xleft">
+                          <a href="http://www.apache.org/" class="externalLink">Apache</a>
+        &gt;
+                  <a href="../../index.html">Maven</a>
+        &gt;
+        Guide to Testing Development Versions of Plugins
+        </div>
+            <div class="xright">        
+                                    Last Published: 2012-12-10
+            </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="leftColumn">
+      <div id="navcolumn">
+             
+                                                   <h5>Main</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../index.html">Welcome</a>
+            </li>
+          </ul>
+                       <h5>Get Maven</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../download.html">Download</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../license.html">License</a>
+            </li>
+          </ul>
+                       <h5>IDE Integration</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../eclipse-plugin.html">Eclipse</a>
+            </li>
+                  <li class="none">
+                  <a href="../../netbeans-module.html">NetBeans</a>
+            </li>
+          </ul>
+                       <h5>About Maven</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../what-is-maven.html">What is Maven?</a>
+            </li>
+                  <li class="none">
+                  <a href="../../maven-features.html">Features</a>
+            </li>
+                  <li class="none">
+                  <a href="../../general.html">FAQ (official)</a>
+            </li>
+                  <li class="none">
+                  <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+            </li>
+          </ul>
+                       <h5>Documentation</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../plugins/index.html">Maven Plugins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/index.html">Index (category)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../run-maven/index.html">Running Maven</a>
+            </li>
+                                                                                                                                            <li class="collapsed">
+                  <a href="../../users/index.html">User Centre</a>
+                  </li>
+                                                                                                        <li class="collapsed">
+                  <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+                  </li>
+                  <li class="none">
+                  <a href="../../repository/index.html">Maven Repository Centre</a>
+            </li>
+                  <li class="none">
+                  <a href="../../developers/index.html">Maven Developer Centre</a>
+            </li>
+                  <li class="none">
+                  <a href="../../articles.html">Books and Resources</a>
+            </li>
+                  <li class="none">
+                  <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+            </li>
+          </ul>
+                       <h5>Community</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../community.html">Community Overview</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+            </li>
+                  <li class="none">
+                  <a href="../../users/getting-help.html">Getting Help</a>
+            </li>
+                  <li class="none">
+                  <a href="../../issue-tracking.html">Issue Tracking</a>
+            </li>
+                  <li class="none">
+                  <a href="../../source-repository.html">Source Repository</a>
+            </li>
+                  <li class="none">
+                  <a href="../../team-list.html">The Maven Team</a>
+            </li>
+          </ul>
+                       <h5>Project Documentation</h5>
+                  <ul>
+                                                                                                                          <li class="collapsed">
+                  <a href="../../project-info.html">Project Information</a>
+                  </li>
+          </ul>
+                       <h5>Maven Projects</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../ant-tasks/index.html">Ant Tasks</a>
+            </li>
+                  <li class="none">
+                  <a href="../../archetype/index.html">Archetype</a>
+            </li>
+                  <li class="none">
+                  <a href="../../doxia/index.html">Doxia</a>
+            </li>
+                  <li class="none">
+                  <a href="../../jxr/index.html">JXR</a>
+            </li>
+                  <li class="none">
+                  <a href="../../maven-1.x/index.html">Maven 1.x</a>
+            </li>
+                  <li class="none">
+                  <a href="../../index.html">Maven 2 & 3</a>
+            </li>
+                  <li class="none">
+                  <a href="../../pom/index.html">Parent POMs</a>
+            </li>
+                  <li class="none">
+                  <a href="../../plugins/index.html">Plugins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../plugin-tools/index.html">Plugin Tools</a>
+            </li>
+                  <li class="none">
+                  <a href="../../scm/index.html">SCM</a>
+            </li>
+                  <li class="none">
+                  <a href="../../shared/index.html">Shared Components</a>
+            </li>
+                  <li class="none">
+                  <a href="../../skins/index.html">Skins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../surefire/index.html">Surefire</a>
+            </li>
+                  <li class="none">
+                  <a href="../../wagon/index.html">Wagon</a>
+            </li>
+          </ul>
+                       <h5>ASF</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+            </li>
+          </ul>
+                                 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+          <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+        </a>
+                       
+                               </div>
+    </div>
+    <div id="bodyColumn">
+      <div id="contentBox">
+        <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements.  See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership.  The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License.  You may obtain a copy of the License at --><!--  --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!--  --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied.  See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
 ces/apt-format.html --><div class="section"><h2>Guide to Testing Development Versions of Plugins<a name="Guide_to_Testing_Development_Versions_of_Plugins"></a></h2><div class="section"><h3>Why would I want to do this?<a name="Why_would_I_want_to_do_this"></a></h3><p>If a bug you are encountering has been reported as fixed but not yet released, you can confirm that it has been fixed for you. Or perhaps you just like to live on the bleeding edge.</p><p>You are highly encouraged to join the development list for the project and provide your feedback, or help promote release of the plugin in question.</p><p><i>Note:</i> This is <b>not</b> recommended as an everyday or in production practice! Snapshots are for testing purposes only and are not official releases. For more information, see <a class="externalLink" href="http://www.apache.org/dev/release.html#what"> the Releases FAQ</a>.</p></div><div class="section"><h3>How do I do this?<a name="How_do_I_do_this"></a></h3><p>Developm
 ent versions of Maven plugins are periodically published to the repository: <a class="externalLink" href="http://repository.apache.org/snapshots/">http://repository.apache.org/snapshots/</a>.</p><p><i>Note:</i> Currently, this is not done automatically by our continuous integration setup. This is coming soon.</p><p>Other sites may publish there own - for example, the Mojo project hosts theirs at <a class="externalLink" href="http://snapshots.repository.codehaus.org/">http://snapshots.repository.codehaus.org/</a></p><p>The first step is to include this in your project:</p><div><pre>&lt;project&gt;
+  ...
+  &lt;pluginRepositories&gt;
+    &lt;pluginRepository&gt;
+      &lt;id&gt;apache.snapshots&lt;/id&gt;
+      &lt;url&gt;http://repository.apache.org/snapshots/&lt;/url&gt;
+    &lt;/pluginRepository&gt;
+  &lt;/pluginRepositories&gt;
+  ...
+&lt;/project&gt;</pre></div><p>After this is included, there are three ways to use the updated versions:</p><ul><li>Set the appropriate version in the plugin, eg <tt>2.0.1-SNAPSHOT</tt></li><li>If you have not specified a version, use the <tt>-U</tt> switch to update plugins for the given Maven run</li><li>You can have Maven automatically check for updates on a given interval, for example:<div><pre>&lt;project&gt;
+  ...
+  &lt;pluginRepositories&gt;
+    &lt;pluginRepository&gt;
+      &lt;id&gt;apache.snapshots&lt;/id&gt;
+      &lt;url&gt;http://repository.apache.org/snapshots/&lt;/url&gt;
+      &lt;!-- The releases element here is due to an issue in Maven 2.0 that will be
+           fixed in future releases. This should be able to be disabled altogether. --&gt;
+      &lt;releases&gt;
+        &lt;updatePolicy&gt;daily&lt;/updatePolicy&gt;
+      &lt;/releases&gt;
+      &lt;snapshots&gt;
+        &lt;updatePolicy&gt;daily&lt;/updatePolicy&gt;
+      &lt;/snapshots&gt;
+    &lt;/pluginRepository&gt;
+  &lt;/pluginRepositories&gt;
+  ...
+&lt;/project&gt;</pre></div></li></ul><p><i>Note:</i> These last two techniques mean that <i>every</i> plugin will be updated to the latest snapshot version.</p><p>The development version will stop being used if the <tt>&lt;pluginRepository&gt;</tt> element is removed from your POM and the version is set back to the release version. If you are using the command line or an unspecified version, you will also need to remove the version from the local repository.</p></div><div class="section"><h3>Using Settings without Modifying the Project<a name="Using_Settings_without_Modifying_the_Project"></a></h3><p>If you are using the goals from the command line on a number of projects, you should include this in your <tt>settings.xml</tt> file instead.</p><p>You need to modify your <tt>~/.m2/settings.xml</tt> file to include two new profiles and then when you need access to the plugin snapshots use <tt>-Papache</tt>. The profile only needs to be enabled once so that the plugins can be d
 ownloaded into you local repository. Once in your local repository Maven can succesfully resolve the dependencies and the profile no longer needs to be activated.</p><div class="source"><pre>&lt;settings&gt;
+  ...
+  &lt;profiles&gt;
+    &lt;profile&gt;
+      &lt;id&gt;apache&lt;/id&gt;
+      &lt;pluginRepositories&gt;
+        &lt;pluginRepository&gt;
+          &lt;id&gt;apache.snapshots&lt;/id&gt;
+          &lt;name&gt;Maven Plugin Snapshots&lt;/name&gt;
+          &lt;url&gt;http://repository.apache.org/snapshots/&lt;/url&gt;
+          &lt;releases&gt;
+            &lt;enabled&gt;false&lt;/enabled&gt;
+          &lt;/releases&gt;
+          &lt;snapshots&gt;
+            &lt;enabled&gt;true&lt;/enabled&gt;
+          &lt;/snapshots&gt;
+        &lt;/pluginRepository&gt;
+      &lt;/pluginRepositories&gt;
+    &lt;/profile&gt;
+  &lt;/profiles&gt;
+  ...
+&lt;/settings&gt;</pre></div><p>When invoking Maven for Apache profile, do it like this:</p><div class="source"><pre>mvn -Papache &lt;phase|goal&gt;</pre></div></div><div class="section"><h3>Using a Repository Manager<a name="Using_a_Repository_Manager"></a></h3><p>In addition to the above you may want to use a repository manager so that you can retain the builds you have been using. For information on this technique, see the <a href="./guide-testing-releases.html"> Guide to Testing Staged Releases</a>.</p></div><div class="section"><h3>How do I make changes to the source and test development versions of the plugins?<a name="How_do_I_make_changes_to_the_source_and_test_development_versions_of_the_plugins"></a></h3><p>For information on this, see the <a href="./guide-m2-development.html">Guide to Maven 2.0 Development</a>.</p></div></div>
+      </div>
+    </div>
+    <div class="clear">
+      <hr/>
+    </div>
+    <div id="footer">
+      <div class="xright">
+        &#169;            2002-2012
+              The Apache Software Foundation
+            
+                          - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+        Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+      </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+  </body>
+</html>

Added: websites/staging/maven/trunk/content/guides/development/guide-testing-releases.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-testing-releases.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-testing-releases.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,274 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>Maven - Guide to Testing Staged Releases</title>
+    <style type="text/css" media="all">
+      @import url("../../css/maven-base.css");
+      @import url("../../css/maven-theme.css");
+      @import url("../../css/site.css");
+    </style>
+    <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+        <meta name="author" content="Maven Team" />
+        <meta name="Date-Revision-yyyymmdd" content="20121210" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+                                                    
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+                                                        
+<script type="text/javascript">_uacct = "UA-140879-1";
+        urchinTracker();</script>
+                              </head>
+  <body class="composite">
+    <div id="banner">
+                                      <a href="../.././" id="bannerLeft">
+                                                <img src="../../images/apache-maven-project-2.png" alt="" />
+                </a>
+                        <span id="bannerRight">
+                                                <img src="../../images/maven-logo-2.gif" alt="" />
+                </span>
+            <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="breadcrumbs">
+            
+                                   <div class="xleft">
+                          <a href="http://www.apache.org/" class="externalLink">Apache</a>
+        &gt;
+                  <a href="../../index.html">Maven</a>
+        &gt;
+        Guide to Testing Staged Releases
+        </div>
+            <div class="xright">        
+                                    Last Published: 2012-12-10
+            </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="leftColumn">
+      <div id="navcolumn">
+             
+                                                   <h5>Main</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../index.html">Welcome</a>
+            </li>
+          </ul>
+                       <h5>Get Maven</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../download.html">Download</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../license.html">License</a>
+            </li>
+          </ul>
+                       <h5>IDE Integration</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../eclipse-plugin.html">Eclipse</a>
+            </li>
+                  <li class="none">
+                  <a href="../../netbeans-module.html">NetBeans</a>
+            </li>
+          </ul>
+                       <h5>About Maven</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../what-is-maven.html">What is Maven?</a>
+            </li>
+                  <li class="none">
+                  <a href="../../maven-features.html">Features</a>
+            </li>
+                  <li class="none">
+                  <a href="../../general.html">FAQ (official)</a>
+            </li>
+                  <li class="none">
+                  <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+            </li>
+          </ul>
+                       <h5>Documentation</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../plugins/index.html">Maven Plugins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/index.html">Index (category)</a>
+            </li>
+                  <li class="none">
+                  <a href="../../run-maven/index.html">Running Maven</a>
+            </li>
+                                                                                                                                            <li class="collapsed">
+                  <a href="../../users/index.html">User Centre</a>
+                  </li>
+                                                                                                        <li class="collapsed">
+                  <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+                  </li>
+                  <li class="none">
+                  <a href="../../repository/index.html">Maven Repository Centre</a>
+            </li>
+                  <li class="none">
+                  <a href="../../developers/index.html">Maven Developer Centre</a>
+            </li>
+                  <li class="none">
+                  <a href="../../articles.html">Books and Resources</a>
+            </li>
+                  <li class="none">
+                  <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+            </li>
+          </ul>
+                       <h5>Community</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../community.html">Community Overview</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+            </li>
+                  <li class="none">
+                  <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+            </li>
+                  <li class="none">
+                  <a href="../../users/getting-help.html">Getting Help</a>
+            </li>
+                  <li class="none">
+                  <a href="../../issue-tracking.html">Issue Tracking</a>
+            </li>
+                  <li class="none">
+                  <a href="../../source-repository.html">Source Repository</a>
+            </li>
+                  <li class="none">
+                  <a href="../../team-list.html">The Maven Team</a>
+            </li>
+          </ul>
+                       <h5>Project Documentation</h5>
+                  <ul>
+                                                                                                                          <li class="collapsed">
+                  <a href="../../project-info.html">Project Information</a>
+                  </li>
+          </ul>
+                       <h5>Maven Projects</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="../../ant-tasks/index.html">Ant Tasks</a>
+            </li>
+                  <li class="none">
+                  <a href="../../archetype/index.html">Archetype</a>
+            </li>
+                  <li class="none">
+                  <a href="../../doxia/index.html">Doxia</a>
+            </li>
+                  <li class="none">
+                  <a href="../../jxr/index.html">JXR</a>
+            </li>
+                  <li class="none">
+                  <a href="../../maven-1.x/index.html">Maven 1.x</a>
+            </li>
+                  <li class="none">
+                  <a href="../../index.html">Maven 2 & 3</a>
+            </li>
+                  <li class="none">
+                  <a href="../../pom/index.html">Parent POMs</a>
+            </li>
+                  <li class="none">
+                  <a href="../../plugins/index.html">Plugins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../plugin-tools/index.html">Plugin Tools</a>
+            </li>
+                  <li class="none">
+                  <a href="../../scm/index.html">SCM</a>
+            </li>
+                  <li class="none">
+                  <a href="../../shared/index.html">Shared Components</a>
+            </li>
+                  <li class="none">
+                  <a href="../../skins/index.html">Skins</a>
+            </li>
+                  <li class="none">
+                  <a href="../../surefire/index.html">Surefire</a>
+            </li>
+                  <li class="none">
+                  <a href="../../wagon/index.html">Wagon</a>
+            </li>
+          </ul>
+                       <h5>ASF</h5>
+                  <ul>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+            </li>
+                  <li class="none">
+                  <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+            </li>
+          </ul>
+                                 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+          <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+        </a>
+                       
+                               </div>
+    </div>
+    <div id="bodyColumn">
+      <div id="contentBox">
+        <div class="section"><h2>Guide to Testing Staged Releases<a name="Guide_to_Testing_Staged_Releases"></a></h2><p>As part of the release process, the artifacts are staged in a temporary repository for testing and evaluation before voting. Such repositories are not available by default, so to use them your project must be configured appropriately.</p><p>The steps are as follows:</p><ul><li>add the repository or plugin repository to your POM or settings (see below)</li><li>ensure you are using the version being released of the artifacts in your project, e.g. by setting the <tt>&lt;version&gt;</tt> in the <tt>&lt;plugin&gt;</tt> tag.</li><li>test the release</li><li>remove the repository from your POM if it was specified there</li><li>remove the artifacts from your local repository when you have completed testing</li></ul><p>The repository configuration for testing a plugin will typically look something like this (it will be provided in the vote email):</p><div><pre>  ...
+  &lt;pluginRepositories&gt;
+    &lt;pluginRepository&gt;
+      &lt;id&gt;staged-releases&lt;/id&gt;
+      &lt;url&gt;http://people.apache.org/~dfabulich/stage-repo&lt;/url&gt;
+    &lt;/pluginRepository&gt;
+  &lt;/pluginRepositories&gt;
+  ...</pre></div><p>The important thing is that the staged release does not pollute your eventual environment as it may change if the vote fails and the release is made again. This is why clearing the local repository is necessary, but if you are using a repository manager this is also important to clear. The following provides instructions for setting Archiva up in such a way that the artifacts are isolated already.</p><div class="section"><h3>Setting up Archiva to Test Staged Releases<a name="Setting_up_Archiva_to_Test_Staged_Releases"></a></h3><p>These steps will be similar for any repository manager - please refer to their individual documentation for instructions on how to configure remote proxies.</p><p>For Archiva, the first step is to create a new managed repository for the staged releases. This will ensure they remain isolated from your environment. On the repositories tab, add a new managed repository with the settings:</p><ul><li>Identifier = <tt>staged-releases</
 tt></li><li>Name = Staged Releases</li><li>Directory = <tt>/path/to/repositories/staged-releases</tt></li><li>Uncheck 'Scannable'</li></ul><p>Next add a remote repository with settings similar to the following:</p><ul><li>Identifier = <tt>dfabulich.staged.releases</tt></li><li>Name = dfabulich Staged Releases</li><li>URL = <tt>http://people.apache.org/~dfabulich/staging-repo/</tt></li></ul><p>Finally, add a proxy connector to connect the two repositories:</p><ul><li>Managed repository = <tt>staged-releases</tt></li><li>Remote repository = <tt>dfabulich.staged</tt></li><li>Release policy = <tt>once</tt></li><li>Snapshot policy = <tt>never</tt></li><li>White list = <tt>org/apache/maven/**</tt></li></ul><p>You can then utilise this repository from your POM or settings in the same way, but with the alternate URL of <tt>http://localhost:8080/archiva/repository/staged-releases/</tt>.</p><p>The advantage of this approach is that you can usually remove your entire local repository a
 fterwards and after removing the staged repository from your POM the artifacts will no longer be used. There is no need to remove the repository or artifacts from Archiva itself - unless a staged release is updated for further testing.</p><p>It is also quite easy to test another staged release at a later date by reusing the repository, or adding a proxy connector and remote repository for a different staging repository.</p><p>If you are using the repository mirroring technique to lock down to the repository manager in your environment, you would add an additional mirror to correspond to the additional repository in the POM, such as:</p><div><pre>  ...
+  &lt;mirror&gt;
+    &lt;id&gt;staged-releases-mirror&lt;/id&gt;
+    &lt;url&gt;http://localhost:8080/archiva/repository/staged-releases/&lt;/url&gt;
+    &lt;mirrorOf&gt;staged-releases&lt;/mirrorOf&gt;
+  &lt;/mirror&gt;
+  ...</pre></div></div><div class="section"><h3>Using a Settings Profile<a name="Using_a_Settings_Profile"></a></h3><p>If you regularly test staged releases and want to have a more convenient way to add the repository to a build without modifying your POM, you may add a profile to your POM:</p><div><pre>  ...
+  &lt;profiles&gt;
+    &lt;profile&gt;
+      &lt;id&gt;staged-releases&lt;/id&gt;
+      &lt;pluginRepositories&gt;
+        &lt;pluginRepository&gt;
+          &lt;id&gt;staged-releases&lt;/id&gt;
+          &lt;url&gt;http://people.apache.org/~dfabulich/stage-repo&lt;/url&gt;
+        &lt;/pluginRepository&gt;
+      &lt;/pluginRepositories&gt;
+    &lt;/profile&gt;
+  ...</pre></div><p>With this in place, you can activate it by simply changing the plugin version to the one you are testing in the POM as above, then run the build with the following command:</p><div><pre>mvn clean install -Pstaged-releases</pre></div><p>Note that the same conditions apply as above about cleaning out the local repository to prevent pollution of your local build environment.</p></div></div>
+      </div>
+    </div>
+    <div class="clear">
+      <hr/>
+    </div>
+    <div id="footer">
+      <div class="xright">
+        &#169;            2002-2012
+              The Apache Software Foundation
+            
+                          - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+        Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+      </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+  </body>
+</html>



Mime
View raw message