You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2019/06/09 13:59:37 UTC
svn commit: r1860906 [7/22] - in /maven/website/content: ./
apache-resource-bundles/ archives/maven-2.x/ background/ developers/
developers/conventions/ developers/release/ developers/website/ docs/
docs/2.0.1/ docs/2.0.10/ docs/2.0.11/ docs/2.0.2/ doc...
Modified: maven/website/content/guides/development/guide-plugin-documentation.html
==============================================================================
--- maven/website/content/guides/development/guide-plugin-documentation.html (original)
+++ maven/website/content/guides/development/guide-plugin-documentation.html Sun Jun 9 13:59:34 2019
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from content/apt/guides/development/guide-plugin-documentation.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/guides/development/guide-plugin-documentation.apt at 2019-06-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -120,49 +120,43 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
-<h2><a name="Introduction"></a>Introduction</h2>
-<div class="section">
+<section>
+<h2><a name="Introduction"></a>Introduction</h2><section>
<h3><a name="Where_did_the_standard_come_from.3F"></a>Where did the standard come from?</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">
+<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></section><section>
<h3><a name="Why_do_we_need_a_documentation_standard.3F"></a>Why do we need a documentation standard?</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">
+<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></section></section><section>
<h2><a name="Generated_Documentation"></a>Generated Documentation </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 class="prettyprint linenums">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 href="/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">
+<p>It will generate a plugin site based on the information in the POM, <code>src/site</code> and other reporting plugins configured in the POM. The most important reporting plugin is the <a href="/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><section>
<h3><a name="POM_Elements"></a>POM Elements</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">
+<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><section>
<h4><a name="Required_Elements"></a>Required Elements</h4>
<p>Minimum elements for a valid POM:</p>
<ul>
-<li><tt><modelVersion></tt> - POM model version, currently 4.0.0</li>
-<li><tt><groupId></tt> - the package name</li>
-<li><tt><artifactId></tt> - artifact name</li>
-<li><tt><packaging></tt> - type of artifact produced by the POM</li>
-<li><tt><version></tt> - the plugin version</li></ul></div>
-<div class="section">
+<li><code><modelVersion></code> - POM model version, currently 4.0.0</li>
+<li><code><groupId></code> - the package name</li>
+<li><code><artifactId></code> - artifact name</li>
+<li><code><packaging></code> - type of artifact produced by the POM</li>
+<li><code><version></code> - the plugin version</li></ul></section><section>
<h4><a name="Optional_Elements"></a>Optional Elements </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><name></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><description></tt> - project description, an overview of what the plugin can do</li>
-<li><tt><url></tt> - the site of the plugin, normally <i>maven.apache.org</i> or <i>org.mojohaus</i></li>
-<li><tt><prerequisites></tt> - the minimum version of Maven required to use this plugin</li>
-<li><tt><issueManagement></tt> - describes the system used for reporting problems and modification requests
+<li><code><name></code> - 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><code><description></code> - project description, an overview of what the plugin can do</li>
+<li><code><url></code> - the site of the plugin, normally <i>maven.apache.org</i> or <i>org.mojohaus</i></li>
+<li><code><prerequisites></code> - the minimum version of Maven required to use this plugin</li>
+<li><code><issueManagement></code> - describes the system used for reporting problems and modification requests
<div class="source"><pre class="prettyprint linenums"> [...]
<issueManagement>
<system>jira</system>
<url>http://jira.someproject.org</url>
</issueManagement>
[...] </pre></div></li>
-<li><tt><inceptionYear></tt> - year the plugin was first created</li>
-<li><tt><mailingLists></tt> - lists where other users or the developers can be contacted for help and discussions
+<li><code><inceptionYear></code> - year the plugin was first created</li>
+<li><code><mailingLists></code> - lists where other users or the developers can be contacted for help and discussions
<div class="source"><pre class="prettyprint linenums"> [...]
<mailingLists>
<mailingList>
@@ -177,7 +171,7 @@
</mailingList>
</mailingLists>
[...] </pre></div></li>
-<li><tt><licenses></tt> - plugin license
+<li><code><licenses></code> - plugin license
<div class="source"><pre class="prettyprint linenums"> [...]
<licenses>
<license>
@@ -187,7 +181,7 @@
</license>
</licenses>
[...]</pre></div></li>
-<li><tt><scm></tt> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS
+<li><code><scm></code> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS
<div class="source"><pre class="prettyprint linenums"> [...]
<scm>
<connection>scm:svn:http://noonecares.com/some/plugin/project/trunk</connection>
@@ -195,16 +189,15 @@
<url>http://noonecares.com/viewvc/some/project/trunk/</url>
</scm>
[...]</pre></div></li>
-<li><tt><organization></tt> - the organization maintaining the plugin, just in case we need someone to blame
+<li><code><organization></code> - the organization maintaining the plugin, just in case we need someone to blame
<div class="source"><pre class="prettyprint linenums"> [...]
<organization>
<name>Noone Care Software Foundation</name>
<url>http://noonecare.org/</url>
</organization>
- [...]</pre></div></li></ul></div></div>
-<div class="section">
+ [...]</pre></div></li></ul></section></section><section>
<h3><a name="Plugin_Configuration_Parameters"></a>Plugin Configuration Parameters</h3>
-<p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <tt><reporting></tt> section unless it is already inherited from a parent POM:</p>
+<p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <code><reporting></code> section unless it is already inherited from a parent POM:</p>
<div class="source"><pre class="prettyprint linenums"> [...]
<reporting>
<plugins>
@@ -218,7 +211,7 @@
[...] </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
+<li>all <code>@parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand
<div class="source"><pre class="prettyprint linenums"> [...]
/**
* Put something informative here that a regular user can understand.
@@ -242,13 +235,11 @@ public class ExampleMojo
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">
+<li>the <code>@component</code> and <code>@readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li></ul></section><section>
<h3><a name="Site_Organization"></a>Site Organization </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">
+<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><section>
<h4><a name="Site_Descriptor"></a>Site Descriptor </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>
+<p>The site descriptor describes the navigation links and can be found in <code>src/site/site.xml</code>. Below is the suggested site descriptor template.</p>
<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?>
<project>
<body>
@@ -264,12 +255,11 @@ public class ExampleMojo
<item name="description2" href="examples/example-two.html"/>
</menu>
</body>
-</project></pre></div>
-<div class="section">
+</project></pre></div><section>
<h5><a name="Navigation_Links"></a>Navigation Links</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>
+<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 <code>src/site/apt/index.apt</code> template</p>
<div class="source"><pre class="prettyprint linenums"> ------
Introduction
------
@@ -319,11 +309,11 @@ Plugin Name
* {{{./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>
+<p><code>plugin-info.html</code> 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>
+<p>A well documented project always collates frequently asked questions which are usually located in <code>src/site/fml/faq.fml</code>. The example below provides a template for your FAQ:</p>
<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?>
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
@@ -342,14 +332,13 @@ Plugin Name
<p>For examples of items under "Examples" check these plugin sites:</p>
<ul>
<li><a href="/plugins/maven-javadoc-plugin/">Maven Javadoc Plugin Examples</a></li>
-<li><a href="/plugins/maven-war-plugin/">Maven War Plugin Examples</a></li></ul></li></ul></div></div></div>
-<div class="section">
+<li><a href="/plugins/maven-war-plugin/">Maven War Plugin Examples</a></li></ul></li></ul></section></section></section><section>
<h3><a name="Recommended_Configured_Reports"></a>Recommended Configured Reports</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 particular 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>
+<p>To enable javadoc for your plugin add the following to your <code>pom.xml</code></p>
<div class="source"><pre class="prettyprint linenums"> [...]
<build>
[...]
@@ -370,10 +359,10 @@ Plugin Name
[...]
</reporting>
[...]</pre></div>
-<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><tt>javadoc:javadoc</tt></a> goal for the advanced configurations.</p></li>
+<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><code>javadoc:javadoc</code></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>
+<p>To enable source code cross-references add the following to your <code>pom.xml</code></p>
<div class="source"><pre class="prettyprint linenums"> [...]
<build>
[...]
@@ -388,7 +377,7 @@ Plugin Name
</plugins>
</reporting>
[...] </pre></div>
-<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></li></ul></div></div>
+<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></li></ul></section></section>
</div>
</div>
</div>
Modified: maven/website/content/guides/development/guide-testing-development-plugins.html
==============================================================================
--- maven/website/content/guides/development/guide-testing-development-plugins.html (original)
+++ maven/website/content/guides/development/guide-testing-development-plugins.html Sun Jun 9 13:59:34 2019
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from content/apt/guides/development/guide-testing-development-plugins.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/guides/development/guide-testing-development-plugins.apt at 2019-06-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -120,14 +120,12 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
-<h2><a name="Guide_to_Testing_Development_Versions_of_Plugins"></a>Guide to Testing Development Versions of Plugins</h2>
-<div class="section">
+<section>
+<h2><a name="Guide_to_Testing_Development_Versions_of_Plugins"></a>Guide to Testing Development Versions of Plugins</h2><section>
<h3><a name="Why_would_I_want_to_do_this.3F"></a>Why would I want to do this?</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">
+<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></section><section>
<h3><a name="How_do_I_do_this.3F"></a>How do I do this?</h3>
<p>Development 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>
@@ -146,8 +144,8 @@
</project></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>Set the appropriate version in the plugin, eg <code>2.0.1-SNAPSHOT</code></li>
+<li>If you have not specified a version, use the <code>-U</code> 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><project>
@@ -169,11 +167,10 @@
...
</project></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><pluginRepository></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">
+<p>The development version will stop being used if the <code><pluginRepository></code> 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></section><section>
<h3><a name="Using_Settings_without_Modifying_the_Project"></a>Using Settings without Modifying the Project</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>${user.home}/.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 downloaded 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>
+<p>If you are using the goals from the command line on a number of projects, you should include this in your <code>settings.xml</code> file instead.</p>
+<p>You need to modify your <code>${user.home}/.m2/settings.xml</code> file to include two new profiles and then when you need access to the plugin snapshots use <code>-Papache</code>. The profile only needs to be enabled once so that the plugins can be downloaded 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 class="prettyprint linenums"><settings>
...
<profiles>
@@ -197,13 +194,11 @@
...
</settings></pre></div>
<p>When invoking Maven for Apache profile, do it like this:</p>
-<div class="source"><pre class="prettyprint linenums">mvn -Papache <phase|goal></pre></div></div>
-<div class="section">
+<div class="source"><pre class="prettyprint linenums">mvn -Papache <phase|goal></pre></div></section><section>
<h3><a name="Using_a_Repository_Manager"></a>Using a Repository Manager</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">
+<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></section><section>
<h3><a name="How_do_I_make_changes_to_the_source_and_test_development_versions_of_the_plugins.3F"></a>How do I make changes to the source and test development versions of the plugins?</h3>
-<p>For information on this, see the <a href="./guide-maven-development.html">Guide to Maven Development</a>.</p></div></div>
+<p>For information on this, see the <a href="./guide-maven-development.html">Guide to Maven Development</a>.</p></section></section>
</div>
</div>
</div>
Modified: maven/website/content/guides/development/guide-testing-releases.html
==============================================================================
--- maven/website/content/guides/development/guide-testing-releases.html (original)
+++ maven/website/content/guides/development/guide-testing-releases.html Sun Jun 9 13:59:34 2019
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from content/apt/guides/development/guide-testing-releases.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/guides/development/guide-testing-releases.apt at 2019-06-09
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -120,13 +120,13 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Guide_to_Testing_Staged_Releases"></a>Guide to Testing Staged Releases</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><version></tt> in the <tt><plugin></tt> tag.</li>
+<li>ensure you are using the version being released of the artifacts in your project, e.g. by setting the <code><version></code> in the <code><plugin></code> 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>
@@ -140,29 +140,28 @@
</pluginRepository>
</pluginRepositories>
...</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">
+<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><section>
<h3><a name="Setting_up_Archiva_to_Test_Staged_Releases"></a>Setting up Archiva to Test Staged Releases</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>Identifier = <code>staged-releases</code></li>
<li>Name = Staged Releases</li>
-<li>Directory = <tt>/path/to/repositories/staged-releases</tt></li>
+<li>Directory = <code>/path/to/repositories/staged-releases</code></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>Identifier = <code>dfabulich.staged.releases</code></li>
<li>Name = dfabulich Staged Releases</li>
-<li>URL = <tt>http://people.apache.org/~dfabulich/staging-repo/</tt></li></ul>
+<li>URL = <code>http://people.apache.org/~dfabulich/staging-repo/</code></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>
+<li>Managed repository = <code>staged-releases</code></li>
+<li>Remote repository = <code>dfabulich.staged</code></li>
+<li>Release policy = <code>once</code></li>
+<li>Snapshot policy = <code>never</code></li>
+<li>White list = <code>org/apache/maven/**</code></li></ul>
+<p>You can then utilise this repository from your POM or settings in the same way, but with the alternate URL of <code>http://localhost:8080/archiva/repository/staged-releases/</code>.</p>
<p>The advantage of this approach is that you can usually remove your entire local repository afterwards 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>
@@ -173,8 +172,7 @@
<url>http://localhost:8080/archiva/repository/staged-releases/</url>
<mirrorOf>staged-releases</mirrorOf>
</mirror>
- ...</pre></div></div>
-<div class="section">
+ ...</pre></div></section><section>
<h3><a name="Using_a_Settings_Profile"></a>Using a Settings Profile</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>
@@ -193,7 +191,7 @@
<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 verify -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>
+<p>Note that the same conditions apply as above about cleaning out the local repository to prevent pollution of your local build environment.</p></section></section>
</div>
</div>
</div>