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 [2/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/developers/dependency-policies.html
==============================================================================
--- maven/website/content/developers/dependency-policies.html (original)
+++ maven/website/content/developers/dependency-policies.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/developers/dependency-policies.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/developers/dependency-policies.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,31 +120,26 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
-<h2><a name="Maven_Dependency_Policies"></a>Maven Dependency Policies</h2>
-<div class="section">
+<section>
+<h2><a name="Maven_Dependency_Policies"></a>Maven Dependency Policies</h2><section>
<h3><a name="Scope"></a>Scope</h3>
<p>This page describes the policies around the use of dependencies by the Apache Maven Developers in the process of developing Apache Maven itself.</p>
-<p>This page does not apply to projects hosted outside of the Apache Maven project. In order to remove all doubt, this page only applies to code which has a Subversion URL that starts with <tt>https://svn.apache.org/repo/asf/maven/</tt></p>
-<p>If you have stumbled across this page and you are working on code that does not have a Subversion URL starting with <tt>https://svn.apache.org/repo/asf/maven/</tt> then this page does not apply to you. Or git repositories starting with: https://git-wip-us.apache.org/repos/asf/maven*</p></div>
-<div class="section">
+<p>This page does not apply to projects hosted outside of the Apache Maven project. In order to remove all doubt, this page only applies to code which has a Subversion URL that starts with <code>https://svn.apache.org/repo/asf/maven/</code></p>
+<p>If you have stumbled across this page and you are working on code that does not have a Subversion URL starting with <code>https://svn.apache.org/repo/asf/maven/</code> then this page does not apply to you. Or git repositories starting with: https://git-wip-us.apache.org/repos/asf/maven*</p></section><section>
<h3><a name="Background"></a>Background</h3>
<p>The Apache Maven PMC is tasked with ensuring (among other things) that all legal issues are addressed and that each and every release is the product of the community as a whole.</p>
<p>The Apache Maven project consists of quite a number of components. For the purposes of this policy, we will make a distinction between the core Maven distribution and all the other components.</p>
-<p>The core Maven distribution is the binary and source distributions made available from the https://maven.apache.org/download page. </p></div>
-<div class="section">
+<p>The core Maven distribution is the binary and source distributions made available from the https://maven.apache.org/download page. </p></section><section>
<h3><a name="Applicability"></a>Applicability</h3>
-<p>This policy applies to all changes to dependencies as and from Subversion revision 1067464.</p></div>
-<div class="section">
+<p>This policy applies to all changes to dependencies as and from Subversion revision 1067464.</p></section><section>
<h3><a name="Core_Maven_Distribution_Dependencies"></a>Core Maven Distribution Dependencies</h3>
<p>All dependencies which are included in the Core Maven Distribution must either:</p>
<ul>
<li>be licensed under a <a class="externalLink" href="https://www.apache.org/legal/resolved.html#category-a">Category A license</a>; or</li>
<li>be licensed under a <a class="externalLink" href="https://www.apache.org/legal/resolved.html#category-b">Category B license</a> and approved by a majority vote of the Apache Maven PMC.</li></ul>
-<p>Votes for Category B licenses will be held on the dev@maven.apache.org mailing list. A majority of the PMC must vote in favour of a Category B licensed dependency before a release can be made containing that dependency.</p></div>
-<div class="section">
+<p>Votes for Category B licenses will be held on the dev@maven.apache.org mailing list. A majority of the PMC must vote in favour of a Category B licensed dependency before a release can be made containing that dependency.</p></section><section>
<h3><a name="Non-Core_Dependencies"></a>Non-Core Dependencies</h3>
-<p>Non-Core components may only use Category A or Category B licenses.</p></div></div>
+<p>Non-Core components may only use Category A or Category B licenses.</p></section></section>
</div>
</div>
</div>
Modified: maven/website/content/developers/index.html
==============================================================================
--- maven/website/content/developers/index.html (original)
+++ maven/website/content/developers/index.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/developers/index.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/developers/index.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">
@@ -131,11 +131,10 @@ Brett Porter" />
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Maven_Developer_Centre"></a>Maven Developer Centre</h2>
<p>This documentation centre is for people who are Maven developers, or would like to contribute.</p>
-<p>If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:dev@maven.apache.org">Maven Developer List</a>.</p>
-<div class="section">
+<p>If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:dev@maven.apache.org">Maven Developer List</a>.</p><section>
<h3><a name="Contributors_Resources"></a>Contributors Resources</h3>
<ul>
<li><a href="../guides/development/guide-helping.html">Guide to helping with Maven</a></li>
@@ -144,10 +143,8 @@ Brett Porter" />
<li><a href="../scm.html">Source Code</a></li>
<li><a href="../continuous-integration.html">Continuous Integration</a></li>
<li><a href="../plugin-developers/common-bugs.html"> Common Bugs and Pitfalls</a></li>
-<li><a href="../project-roles.html">Apache Maven Project Roles</a></li></ul></div>
-<div class="section">
-<h3><a name="Committers_Resources"></a>Committers Resources</h3>
-<div class="section">
+<li><a href="../project-roles.html">Apache Maven Project Roles</a></li></ul></section><section>
+<h3><a name="Committers_Resources"></a>Committers Resources</h3><section>
<h4><a name="General_Resources"></a>General Resources</h4>
<ul>
<li><a href="./welcome-to-new-committers.html">Guide for new Maven committers</a></li>
@@ -155,29 +152,25 @@ Brett Porter" />
<li><a href="./committer-settings.html">Committer Settings</a></li>
<li><a href="./java6.html">Java 6 in Plugins and Shared Components</a></li>
<li><a href="./retirement-plan-plugins.html">Retirement Plan for Plugins</a></li>
-<li><a href="./dependency-policies.html">Maven Dependency Policies</a></li></ul></div></div>
-<div class="section">
+<li><a href="./dependency-policies.html">Maven Dependency Policies</a></li></ul></section></section><section>
<h3><a name="Developers_Conventions"></a>Developers Conventions</h3>
<p>There are a number of conventions used in the Maven projects, which contributors and developers alike should follow for consistency's sake.</p>
<ul>
<li><a href="./conventions/code.html">Maven Code Style And Conventions</a></li>
<li><a href="./conventions/jira.html">Maven JIRA Convention</a></li>
<li><a href="./conventions/git.html">Maven Git Convention</a></li></ul>
-<p><b>Note</b>: If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:dev@maven.apache.org">Maven Developer List</a>.</p></div>
-<div class="section">
+<p><b>Note</b>: If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:dev@maven.apache.org">Maven Developer List</a>.</p></section><section>
<h3><a name="Making_Releases"></a>Making Releases</h3>
<ul>
<li><a href="./release/pmc-gpg-keys.html">Making GPG Keys</a></li>
-<li><a href="./release/index.html">Release Process</a></li></ul></div>
-<div class="section">
+<li><a href="./release/index.html">Release Process</a></li></ul></section><section>
<h3><a name="Maven_Website"></a>Maven Website</h3>
<ul>
-<li><a href="./website/index.html">Deploy Maven Website</a></li></ul></div>
-<div class="section">
+<li><a href="./website/index.html">Deploy Maven Website</a></li></ul></section><section>
<h3><a name="Others_Resources"></a>Others Resources</h3>
<ul>
<li><a class="externalLink" href="https://www.apache.org/dev/">ASF Development Infrastructure Information</a></li>
-<li><a class="externalLink" href="https://www.apache.org/foundation/">About the Apache Software Foundation</a></li></ul></div></div>
+<li><a class="externalLink" href="https://www.apache.org/foundation/">About the Apache Software Foundation</a></li></ul></section></section>
</div>
</div>
</div>
Modified: maven/website/content/developers/java6.html
==============================================================================
--- maven/website/content/developers/java6.html (original)
+++ maven/website/content/developers/java6.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/developers/java6.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/developers/java6.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,18 +120,15 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Java_6_in_Plugins_and_Shared_Components"></a>Java 6 in Plugins and Shared Components</h2>
<p>When you want to start using Java 6 features in a plugin, or a shared component, the process described here must be used as decided by the Maven PMC.</p>
-<p>A plugin/component can start using Java 6 features and/or dependencies when the need arises. If there are issues that have already been fixed, but not yet released, the current trunk of the plugin/component must be released first, targeting Java 5. In the announcement for such a final Java 5 version of the plugin/component, we inform the users that this is the last version that will work with Java 5.</p>
-<div class="section">
+<p>A plugin/component can start using Java 6 features and/or dependencies when the need arises. If there are issues that have already been fixed, but not yet released, the current trunk of the plugin/component must be released first, targeting Java 5. In the announcement for such a final Java 5 version of the plugin/component, we inform the users that this is the last version that will work with Java 5.</p><section>
<h3><a name="In_JIRA"></a>In JIRA</h3>
<p>When a plugin/component decides to switch to Java 6, you should set the description field for the versions in JIRA for the plugin/component, so that it is clear which version works with which version of Java. Mark the last Java 5 compatible version with "Last version to work with Java 5", see <a class="externalLink" href="https://issues.apache.org/jira/browse/MCHECKSTYLE/fixforversion/20631">example</a>. Mark the first version that requires Java 6 "This version requires Java 6", see <a class="externalLink" href="https://issues.apache.org/jira/browse/MCHECKSTYLE/fixforversion/20762">example</a>.</p>
-<p>Create an issue "Require Java 6" and schedule it for the first Java 6 version, see <a class="externalLink" href="https://issues.apache.org/jira/browse/MCHECKSTYLE-277">example</a>. Reference this issue when you check in the code changes (see below) into version control</p></div>
-<div class="section">
+<p>Create an issue "Require Java 6" and schedule it for the first Java 6 version, see <a class="externalLink" href="https://issues.apache.org/jira/browse/MCHECKSTYLE-277">example</a>. Reference this issue when you check in the code changes (see below) into version control</p></section><section>
<h3><a name="On_the_plugin.2Fcomponent_site"></a>On the plugin/component site</h3>
-<p>Specify the Java requirements in <tt>index.apt.vm</tt>: "This plugin/component requires Java ${javaVersion}.", see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm?r1=1650811&r2=1652771&pathrev=1658048">example</a>. We need to use the variable ${javaVersion} here, because ${maven.compiler.source} does not work in a site.</p></div>
-<div class="section">
+<p>Specify the Java requirements in <code>index.apt.vm</code>: "This plugin/component requires Java ${javaVersion}.", see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm?r1=1650811&r2=1652771&pathrev=1658048">example</a>. We need to use the variable ${javaVersion} here, because ${maven.compiler.source} does not work in a site.</p></section><section>
<h3><a name="In_the_POM"></a>In the POM</h3>
<p>Make sure these 3 properties are defined, either in the project or in a parent:</p>
<ul>
@@ -140,14 +137,14 @@
<li>maven.compiler.target=${javaVersion}</li></ul>
<p>Here is a list plugins that are defined in a parent, and that already makes use of the above mentioned properties. So it should be enough to just make sure that the effective-pom looks ok.</p>
<ul>
-<li><tt>maven-compiler-plugin</tt> is defined in <tt>maven-parent</tt>, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/pom/tags/maven-parent-26/pom.xml?view=markup#l842">example</a></li>
-<li><tt>maven-enforcer-plugin</tt> and the <tt>enforceBytecodeVersion</tt> rule is defined in <tt>maven-parent</tt>, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/pom/tags/maven-parent-26/pom.xml?view=markup#l946">example</a></li>
-<li><tt>maven-pmd-plugin</tt> is defined in <tt>maven-parent</tt>, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/pom/tags/maven-parent-26/pom.xml?view=markup#l1069">example</a></li></ul>
+<li><code>maven-compiler-plugin</code> is defined in <code>maven-parent</code>, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/pom/tags/maven-parent-26/pom.xml?view=markup#l842">example</a></li>
+<li><code>maven-enforcer-plugin</code> and the <code>enforceBytecodeVersion</code> rule is defined in <code>maven-parent</code>, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/pom/tags/maven-parent-26/pom.xml?view=markup#l946">example</a></li>
+<li><code>maven-pmd-plugin</code> is defined in <code>maven-parent</code>, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/pom/tags/maven-parent-26/pom.xml?view=markup#l1069">example</a></li></ul>
<p>These plugins that are not defined in a parent, so you might need to configure the Java version for them in the plugin/component </p>
<ul>
-<li><tt>animal-sniffer-maven-plugin</tt> is only defined in selected plugins, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?view=markup#l307">example in <tt>maven-checkstyle-plugin</tt></a>. We should move it to maven-parent.</li>
-<li><tt>buildhelper-maven-plugin</tt> is used to create the signature for animal-sniffer and is only defined in selected plugins, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?view=markup#l295">example in <tt>maven-checkstyle-plugin</tt></a>. We should move it to maven-parent.</li>
-<li><tt>maven-plugin-plugin</tt> is only defined in selected plugins, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?view=markup#l370">example in <tt>maven-checkstyle-plugin</tt></a>. We should move it to maven-plugins parent.</li></ul></div></div>
+<li><code>animal-sniffer-maven-plugin</code> is only defined in selected plugins, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?view=markup#l307">example in <code>maven-checkstyle-plugin</code></a>. We should move it to maven-parent.</li>
+<li><code>buildhelper-maven-plugin</code> is used to create the signature for animal-sniffer and is only defined in selected plugins, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?view=markup#l295">example in <code>maven-checkstyle-plugin</code></a>. We should move it to maven-parent.</li>
+<li><code>maven-plugin-plugin</code> is only defined in selected plugins, see <a class="externalLink" href="https://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/pom.xml?view=markup#l370">example in <code>maven-checkstyle-plugin</code></a>. We should move it to maven-plugins parent.</li></ul></section></section>
</div>
</div>
</div>
Modified: maven/website/content/developers/mojo-api-specification.html
==============================================================================
--- maven/website/content/developers/mojo-api-specification.html (original)
+++ maven/website/content/developers/mojo-api-specification.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/xdoc/developers/mojo-api-specification.xml at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/xdoc/developers/mojo-api-specification.xml 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">
@@ -133,7 +133,7 @@
<div id="bodyColumn" class="span10" >
- <div class="section">
+ <section>
<h2><a name="Introduction"></a>Introduction</h2>
<p>Starting with Maven, plugins can be written in Java or any of a
@@ -150,27 +150,27 @@
<p>Although the requirements on Mojos are minimal by design, there are
still a very few requirements that Mojo developers must keep in mind. Basically, these Mojo requirements are embodied by the
- <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html"><tt>org.apache.maven.plugin.Mojo</tt></a>
+ <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html">org.apache.maven.plugin.Mojo</a>
interface, which the Mojo
must implement (or else extend its abstract base class counterpart
- <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html"><tt>org.apache.maven.plugin.AbstractMojo</tt></a>
+ <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html">org.apache.maven.plugin.AbstractMojo</a>
). This interface
guarantees the correct execution contract for the Mojo: no parameters,
void return type, and a throws clause that allows only
- <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html"><tt>org.apache.maven.plugin.MojoExecutionException</tt></a>
+ <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html">org.apache.maven.plugin.MojoExecutionException</a>
and its
derivatives. It also guarantees that the Mojo will have access to the
standard Maven user-feedback mechanism,
- <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/logging/Log.html"><tt>org.apache.maven.plugin.logging.Log</tt></a>
+ <a href="/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/logging/Log.html">org.apache.maven.plugin.logging.Log</a>
, so the Mojo can
communicate important events to the console or other log sink.
</p>
<p>As mentioned before, each Plugin - or packaged set of Mojos - must
provide a descriptor called
- <a href="/ref/current/maven-plugin-api/plugin.html"><tt>plugin.xml</tt></a>
+ <a href="/ref/current/maven-plugin-api/plugin.html">plugin.xml</a>
under the path
- <tt>META-INF/maven</tt>
+ META-INF/maven
inside the Plugin jar file. Fortunately,
Maven also provides a set of Javadoc annotations
(named <a href="/plugin-tools/maven-plugin-tools-java/index.html">Mojo Javadoc Tags</a>),
@@ -184,60 +184,55 @@
<p>To serve as a quick reference for the developer, the rest of this page
will document these features (the API, along with the annotations)
which are considered the best practice for developing Mojos.</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="API_Documentation"></a>API Documentation</h2>
-
-<div class="section">
+ <section>
<h3><a name="org.apache.maven.plugin.Mojo"></a>org.apache.maven.plugin.Mojo</h3>
<p>This interface forms the contract required for Mojos to interact
with the Maven infrastructure. It features an
- <tt>execute()</tt>
+ execute()
method, which triggers the Mojo's build-process behavior, and can
throw a
- <tt>MojoExecutionException</tt>
+ MojoExecutionException
if an error condition
occurs. See below for a discussion on proper use of this
- <tt>Exception</tt>
+ Exception
class. Also included is the
- <tt>setLog(..)</tt>
+ setLog(..)
method, which simply allows Maven to inject a
logging mechanism which will allow the Mojo to communicate to the
outside world through standard Maven channels.
</p>
-
-<div class="section">
-<div class="section">
-<div class="section">
+ <section><section><section>
<h6><a name="Method_Summary:"></a>Method Summary:</h6>
<ul>
<li>
- <tt>
+
void setLog( org.apache.maven.plugin.logging.Log )
- </tt>
+
<p>Inject a standard Maven logging mechanism to allow this Mojo
to communicate events and feedback to the user.</p>
</li>
<li>
- <tt>
+
void execute() throws org.apache.maven.plugin.MojoExecutionException
- </tt>
+
<p>Perform whatever build-process behavior this Mojo implements.
This is the main trigger for the Mojo inside the Maven system,
and allows the Mojo to communicate fatal errors by throwing an
- instance of <tt>MojoExecutionException</tt>.
+ instance of MojoExecutionException.
</p>
<p>The
- <tt>MojoExecutionException</tt> (and all error
+ MojoExecutionException (and all error
conditions inside the Mojo) should be handled very carefully.
The simple wrapping of lower-level exceptions without providing
any indication of a user-friendly probable cause is strictly
@@ -246,36 +241,32 @@
coherent step within the Mojo's execution. Developers are then
in a much better position to diagnose the cause of any error,
and provide user-friendly feedback in the message of the
- <tt>MojoExecutionException</tt>.
+ MojoExecutionException.
</p>
</li>
</ul>
- </div></div></div></div>
-
-<div class="section">
+ </section></section></section></section>
+ <section>
<h3><a name="org.apache.maven.plugin.AbstractMojo"></a>org.apache.maven.plugin.AbstractMojo</h3>
<p>Currently, this abstract base class simply takes care of managing
the Maven log for concrete derivations. In keeping with this, it
provides a
- <tt>protected</tt>
+ protected
method,
- <tt>getLog():Log</tt>
+ getLog():Log
,
to furnish Log access to these concrete implementations.
</p>
-
-<div class="section">
-<div class="section">
-<div class="section">
+ <section><section><section>
<h6><a name="Method_Summary:"></a>Method Summary:</h6>
<ul>
<li>
- <tt>
+
public void setLog( org.apache.maven.plugin.logging.Log )
- </tt>
+
<p>
<b>[IMPLEMENTED]</b>
@@ -286,7 +277,7 @@
</li>
<li>
- <tt>protected Log getLog()</tt>
+ protected Log getLog()
<p>
<b>[IMPLEMENTED]</b>
@@ -297,9 +288,9 @@
</li>
<li>
- <tt>
+
void execute() throws org.apache.maven.plugin.MojoExecutionException
- </tt>
+
<p>
<b>[ABSTRACT]</b>
@@ -307,41 +298,37 @@
<p>Perform whatever build-process behavior this Mojo implements.
See the documentation for
- <tt>Mojo</tt>
+ Mojo
above for more
information.
</p>
</li>
</ul>
- </div></div></div></div>
-
-<div class="section">
+ </section></section></section></section>
+ <section>
<h3><a name="org.apache.maven.plugin.logging.Log"></a>org.apache.maven.plugin.logging.Log</h3>
<p>This interface supplies the API for providing feedback to the user
from the Mojo, using standard Maven channels. There should be no big
surprises here, although you may notice that the methods accept
- <tt>java.lang.CharSequence</tt>
+ java.lang.CharSequence
rather than
- <tt>java.lang.String</tt>
+ java.lang.String
. This is provided mainly as a
convenience, to enable developers to pass things like
- <tt>StringBuffer</tt>
+ StringBuffer
directly into the logger, rather than
formatting first by calling
- <tt>toString()</tt>
+ toString()
.
</p>
-
-<div class="section">
-<div class="section">
-<div class="section">
+ <section><section><section>
<h6><a name="Method_Summary:"></a>Method Summary:</h6>
<ul>
<li>
- <tt>void debug( java.lang.CharSequence )</tt>
+ void debug( java.lang.CharSequence )
<p>Send a message to the user in the
<b>debug</b>
@@ -350,9 +337,9 @@
</li>
<li>
- <tt>
+
void debug( java.lang.CharSequence, java.lang.Throwable )
- </tt>
+
<p>Send a message (and accompanying exception) to the user in the
<b>debug</b>
@@ -362,7 +349,7 @@
</li>
<li>
- <tt>void debug( java.lang.Throwable )</tt>
+ void debug( java.lang.Throwable )
<p>Send an exception to the user in the
<b>debug</b>
@@ -373,7 +360,7 @@
</li>
<li>
- <tt>void info( java.lang.CharSequence )</tt>
+ void info( java.lang.CharSequence )
<p>Send a message to the user in the
<b>info</b>
@@ -382,9 +369,9 @@
</li>
<li>
- <tt>
+
void info( java.lang.CharSequence, java.lang.Throwable )
- </tt>
+
<p>Send a message (and accompanying exception) to the user in the
<b>info</b>
@@ -394,7 +381,7 @@
</li>
<li>
- <tt>void info( java.lang.CharSequence )</tt>
+ void info( java.lang.CharSequence )
<p>Send an exception to the user in the
<b>info</b>
@@ -405,7 +392,7 @@
</li>
<li>
- <tt>void warn( java.lang.CharSequence )</tt>
+ void warn( java.lang.CharSequence )
<p>Send a message to the user in the
<b>warn</b>
@@ -414,9 +401,9 @@
</li>
<li>
- <tt>
+
void warn( java.lang.CharSequence, java.lang.Throwable )
- </tt>
+
<p>Send a message (and accompanying exception) to the user in the
<b>warn</b>
@@ -426,7 +413,7 @@
</li>
<li>
- <tt>void warn( java.lang.CharSequence )</tt>
+ void warn( java.lang.CharSequence )
<p>Send an exception to the user in the
<b>warn</b>
@@ -437,7 +424,7 @@
</li>
<li>
- <tt>void error( java.lang.CharSequence )</tt>
+ void error( java.lang.CharSequence )
<p>Send a message to the user in the
<b>error</b>
@@ -446,9 +433,9 @@
</li>
<li>
- <tt>
+
void error( java.lang.CharSequence, java.lang.Throwable )
- </tt>
+
<p>Send a message (and accompanying exception) to the user in the
<b>error</b>
@@ -458,7 +445,7 @@
</li>
<li>
- <tt>void error( java.lang.CharSequence )</tt>
+ void error( java.lang.CharSequence )
<p>Send an exception to the user in the
<b>error</b>
@@ -468,10 +455,9 @@
</p>
</li>
</ul>
- </div></div></div></div>
- </div>
-
-<div class="section">
+ </section></section></section></section>
+ </section>
+ <section>
<h2><a name="The_Descriptor_and_Annotations"></a>The Descriptor and Annotations</h2>
<p>In addition to the normal Java requirements in terms of interfaces
@@ -503,7 +489,7 @@
<p>The plugin descriptor (see <a href="/ref/current/maven-plugin-api/plugin.html">descriptor reference</a>)
must be provided in a jar resource with the path:
- <tt>META-INF/maven/plugin.xml</tt>, and it must contain the following:
+ META-INF/maven/plugin.xml, and it must contain the following:
</p>
<table border="0" class="table table-striped">
@@ -519,35 +505,35 @@
<tr class="b">
-<td><tt>mojos</tt></td>
+<td>mojos</td>
<td>Yes</td>
<td>Descriptors for each Mojo provided by the plugin, each inside a
- <b><tt>mojo</tt></b>
+ <b>mojo</b>
sub-element. Mojo descriptors are covered in detail
below. Obviously, a plugin without any declared Mojos doesn't
make sense, so the
- <b><tt>mojos</tt></b>
+ <b>mojos</b>
element is required, along with
at least one
- <b><tt>mojo</tt></b>
+ <b>mojo</b>
sub-element.
</td>
</tr>
<tr class="a">
-<td><tt>dependencies</tt></td>
+<td>dependencies</td>
<td>Yes</td>
<td>A set of dependencies which the plugin requires in order to
function. Each dependency is provided inside a
- <b><tt>dependency</tt></b>
+ <b>dependency</b>
sub-element. Dependency specifications are covered below. Since
all plugins must have a dependency on
- <tt>maven-plugin-api</tt>
+ maven-plugin-api
, this element is effectively
required.
<i>Using the plugin toolset, these dependencies can be
@@ -575,9 +561,9 @@
<tr class="b">
-<td><tt>aggregator</tt></td>
+<td>aggregator</td>
-<td><tt>@aggregator</tt></td>
+<td>@aggregator</td>
<td>No</td>
@@ -587,9 +573,9 @@
<tr class="a">
-<td><tt>configurator</tt></td>
+<td>configurator</td>
-<td><tt>@configurator <roleHint></tt></td>
+<td>@configurator <roleHint></td>
<td>No</td>
@@ -603,18 +589,18 @@
<tr class="b">
-<td><tt>execute</tt></td>
+<td>execute</td>
<td>
<ul>
-<li><tt>@execute phase="<phaseName>"
- lifecycle="<lifecycleId>"</tt></li>
+<li>@execute phase="<phaseName>"
+ lifecycle="<lifecycleId>"</li>
-<li><tt>@execute phase="<phaseName>"</tt></li>
+<li>@execute phase="<phaseName>"</li>
-<li><tt>@execute goal="<goalName>"</tt></li>
+<li>@execute goal="<goalName>"</li>
</ul>
</td>
@@ -623,16 +609,16 @@
<td>When this goal is invoked, it will first invoke a parallel lifecycle, ending at the given
phase. If a goal is provided instead of a phase, that goal will be executed in isolation.
The execution of either will not affect the current project, but instead make available the
- <tt>${executedProject}</tt> expression if required. An alternate lifecycle can also be
+ ${executedProject} expression if required. An alternate lifecycle can also be
provided: for more information see the documentation on the
<a href="../guides/introduction/introduction-to-the-lifecycle.html">build lifecycle</a>.</td>
</tr>
<tr class="a">
-<td><tt>executionStrategy</tt></td>
+<td>executionStrategy</td>
-<td><tt>@executionStrategy <strategy></tt></td>
+<td>@executionStrategy <strategy></td>
<td>No</td>
@@ -643,9 +629,9 @@
<tr class="b">
-<td><tt>goal</tt></td>
+<td>goal</td>
-<td><tt>@goal <goalName></tt></td>
+<td>@goal <goalName></td>
<td>Yes</td>
@@ -655,47 +641,47 @@
<tr class="a">
-<td><tt>inheritByDefault</tt></td>
+<td>inheritByDefault</td>
-<td><tt>@inheritByDefault <true|false></tt></td>
+<td>@inheritByDefault <true|false></td>
-<td>No. Default: <tt>true</tt></td>
+<td>No. Default: true</td>
<td>Specify that the Mojo is inherited.</td>
</tr>
<tr class="b">
-<td><tt>instantiationStrategy</tt></td>
+<td>instantiationStrategy</td>
-<td><tt>@instantiationStrategy <per-lookup></tt></td>
+<td>@instantiationStrategy <per-lookup></td>
-<td>No. Default: <tt>per-lookup</tt></td>
+<td>No. Default: per-lookup</td>
<td>Specify the instantiation strategy.</td>
</tr>
<tr class="a">
-<td><tt>phase</tt></td>
+<td>phase</td>
-<td><tt>@phase <phaseName></tt></td>
+<td>@phase <phaseName></td>
<td>No</td>
<td>
Defines a default phase to bind a mojo execution to if the user does not explicitly set a phase in the POM.
<i>Note:</i> This annotation will not automagically make a mojo run when the plugin declaration is added
- to the POM. It merely enables the user to omit the <tt><phase></tt> element from the surrounding
- <tt><execution></tt> element.
+ to the POM. It merely enables the user to omit the <phase> element from the surrounding
+ <execution> element.
</td>
</tr>
<tr class="b">
-<td><tt>requiresDependencyResolution</tt></td>
+<td>requiresDependencyResolution</td>
-<td><tt>@requiresDependencyResolution <requiredClassPath></tt></td>
+<td>@requiresDependencyResolution <requiredClassPath></td>
<td>No</td>
@@ -723,7 +709,7 @@
<tr class="b">
-<td><tt>compile</tt></td>
+<td>compile</td>
<td>X</td>
@@ -738,7 +724,7 @@
<tr class="a">
-<td><tt>runtime</tt></td>
+<td>runtime</td>
<td>-</td>
@@ -753,7 +739,7 @@
<tr class="b">
-<td><tt>compile+runtime</tt> (since Maven 3.0)</td>
+<td>compile+runtime (since Maven 3.0)</td>
<td>X</td>
@@ -768,7 +754,7 @@
<tr class="a">
-<td><tt>test</tt></td>
+<td>test</td>
<td>X</td>
@@ -781,7 +767,7 @@
<td>X</td>
</tr>
</table>
- If this annotation is present but no scope is specified, the scope defaults to <tt>runtime</tt>. If
+ If this annotation is present but no scope is specified, the scope defaults to runtime. If
the annotation is not present at all, the mojo must not make any assumptions about the artifacts associated
with a Maven project.
</td>
@@ -789,20 +775,20 @@
<tr class="a">
-<td><tt>requiresDependencyCollection</tt></td>
+<td>requiresDependencyCollection</td>
-<td><tt>@requiresDependencyCollection <requiredClassPath></tt></td>
+<td>@requiresDependencyCollection <requiredClassPath></td>
<td>No</td>
<td>
Flags this mojo as requiring information about the dependencies that would make up the specified class path.
- As the name suggests, this annotation is similar to <tt>@requiresDependencyResolution</tt> and supports
+ As the name suggests, this annotation is similar to @requiresDependencyResolution and supports
the same values for <i><requiredClassPath></i>. The important difference is that this annotation will
not resolve the files for the dependencies, i.e. the artifacts associated with a Maven project can lack a
file. As such, this annotation is meant for mojos that only want to analyze the set of transitive
dependencies, in particular during early lifecycle phases where full dependency resolution might fail due to
- projects which haven't been built yet. A mojo may use both this annotation and <tt>@requiresDependencyResolution</tt>
+ projects which haven't been built yet. A mojo may use both this annotation and @requiresDependencyResolution
at the same time. The resolution state of any dependency that is collected but not requested to be resolved
is undefined. Since Maven 3.0.
</td>
@@ -810,60 +796,60 @@
<tr class="b">
-<td><tt>requiresDirectInvocation</tt></td>
+<td>requiresDirectInvocation</td>
-<td><tt>@requiresDirectInvocation <true|false></tt></td>
+<td>@requiresDirectInvocation <true|false></td>
-<td>No. Default: <tt>false</tt></td>
+<td>No. Default: false</td>
<td>Flags this Mojo to be invoke directly.</td>
</tr>
<tr class="a">
-<td><tt>requiresOnline</tt></td>
+<td>requiresOnline</td>
-<td><tt>@requiresOnline <true|false></tt></td>
+<td>@requiresOnline <true|false></td>
-<td>No. Default: <tt>false</tt></td>
+<td>No. Default: false</td>
<td>Flags this Mojo to require online mode for its operation.</td>
</tr>
<tr class="b">
-<td><tt>requiresProject</tt></td>
+<td>requiresProject</td>
-<td><tt>@requiresProject <true|false></tt></td>
+<td>@requiresProject <true|false></td>
-<td>No. Default: <tt>true</tt></td>
+<td>No. Default: true</td>
<td>Flags this Mojo to run inside of a project.</td>
</tr>
<tr class="a">
-<td><tt>requiresReports</tt></td>
+<td>requiresReports</td>
-<td><tt>@requiresReports <true|false></tt></td>
+<td>@requiresReports <true|false></td>
-<td>No. Default: <tt>false</tt></td>
+<td>No. Default: false</td>
<td>Flags this Mojo to require reports. Unsupported since Maven 3.0.</td>
</tr>
<tr class="b">
-<td><tt>threadSafe</tt></td>
+<td>threadSafe</td>
-<td><tt>@threadSafe <true|false></tt></td>
+<td>@threadSafe <true|false></td>
-<td>No. Default: <tt>false</tt></td>
+<td>No. Default: false</td>
<td>
Marks this mojo as being thread-safe, i.e. the mojo safely supports concurrent execution during parallel builds.
Mojos without this annotation will make Maven output a warning when used during a parallel build session.
- The short-hand notation <tt>@threadSafe</tt> without a tag value is equivalent to <tt>@threadSafe true</tt>.
+ The short-hand notation @threadSafe without a tag value is equivalent to @threadSafe true.
Since Maven 3.0.
</td>
</tr>
@@ -872,7 +858,7 @@
<tr class="a">
-<td><tt>description</tt></td>
+<td>description</td>
<td>none (detected)</td>
@@ -887,7 +873,7 @@
<tr class="b">
-<td><tt>implementation</tt></td>
+<td>implementation</td>
<td>none (detected)</td>
@@ -898,11 +884,11 @@
<tr class="a">
-<td><tt>language</tt></td>
+<td>language</td>
<td>none (detected)</td>
-<td>No. Default: <tt>java</tt></td>
+<td>No. Default: java</td>
<td>The implementation language for this Mojo (Java, beanshell, etc.).</td>
</tr>
@@ -911,9 +897,9 @@
<tr class="b">
-<td><tt>deprecated</tt></td>
+<td>deprecated</td>
-<td><tt>@deprecated <deprecated-text></tt></td>
+<td>@deprecated <deprecated-text></td>
<td>No</td>
@@ -924,9 +910,9 @@
<tr class="a">
-<td><tt>since</tt></td>
+<td>since</td>
-<td><tt>@since <since-text></tt></td>
+<td>@since <since-text></td>
<td>No</td>
@@ -971,9 +957,9 @@
<tr class="b">
-<td><tt>alias</tt></td>
+<td>alias</td>
-<td><tt>@parameter alias="myAlias"</tt></td>
+<td>@parameter alias="myAlias"</td>
<td>No</td>
@@ -984,31 +970,31 @@
<tr class="a">
-<td><tt>configuration</tt></td>
+<td>configuration</td>
-<td><tt>@component role="..." roleHint="..."</tt></td>
+<td>@component role="..." roleHint="..."</td>
<td>No</td>
<td>Populates the field with an instance of a Plexus component. This is like declaring a
<i>requirement</i> in a Plexus component. The default requirement will have a role equal
to the declared type of the field, and will use the role hint "default". You can customise
- either of these by providing a <tt>role</tt> and/or <tt>roleHint</tt> parameter.
+ either of these by providing a role and/or roleHint parameter.
<i>e.g.</i>
- <tt>@component role="org.apache.maven.artifact.ArtifactHandler"
- roleHint="ear"</tt>. <b>Note:</b> This is identical to the deprecated
- form of parameter: <tt>@parameter
- expression="${component.yourpackage.YourComponentClass#roleHint}"</tt>. </td>
+ @component role="org.apache.maven.artifact.ArtifactHandler"
+ roleHint="ear". <b>Note:</b> This is identical to the deprecated
+ form of parameter: @parameter
+ expression="${component.yourpackage.YourComponentClass#roleHint}". </td>
</tr>
<tr class="b">
-<td><tt>configuration</tt></td>
+<td>configuration</td>
-<td>maven-plugin-plugin 2.x:<br /><tt>@parameter expression="${aSystemProperty}"
- default-value="${anExpression}"</tt><br /><br />
- maven-plugin-plugin 3.x:<br /><tt>@parameter property="aSystemProperty"
- default-value="${anExpression}"</tt></td>
+<td>maven-plugin-plugin 2.x:<br />@parameter expression="${aSystemProperty}"
+ default-value="${anExpression}"<br /><br />
+ maven-plugin-plugin 3.x:<br />@parameter property="aSystemProperty"
+ default-value="${anExpression}"</td>
<td>No</td>
@@ -1016,18 +1002,18 @@
<p>Specifies the expressions used to calculate the value to be injected into this parameter of
the Mojo at buildtime.</p>
-<p>The expression given by <tt>default-value</tt> is commonly used to refer to
- specific elements in the POM, such as <tt>${project.resources}</tt>, which refers to the list of
+<p>The expression given by default-value is commonly used to refer to
+ specific elements in the POM, such as ${project.resources}, which refers to the list of
resources meant to accompany the classes in the resulting JAR file. Of course, the default value need not
- be an expression but can also be a simple constant like <tt>true</tt> or <tt>1.5</tt>. And for
- parameters of type <tt>String</tt> one can mix expressions with literal values, e.g.
- <tt>${project.artifactId}-${project.version}-special</tt>.</p>
+ be an expression but can also be a simple constant like true or 1.5. And for
+ parameters of type String one can mix expressions with literal values, e.g.
+ ${project.artifactId}-${project.version}-special.</p>
-<p>The system property given by <tt>property</tt> in maven-plugin-plugin 3.x or <tt>expression</tt>
+<p>The system property given by property in maven-plugin-plugin 3.x or expression
in maven-plugin-plugin 2.x
- enables users to override the default value from the command line via <tt>-DaSystemProperty=value</tt>.</p>
+ enables users to override the default value from the command line via -DaSystemProperty=value.</p>
-<p><i>NOTE: If neither <tt>default-value</tt> nor <tt>property</tt> or <tt>expression</tt> are specified,
+<p><i>NOTE: If neither default-value nor property or expression are specified,
the parameter can only be configured from the POM. The use of '${' and '}' in default value is required to delimit actual expressions
which may be evaluated.</i></p>
</td>
@@ -1035,9 +1021,9 @@
<tr class="a">
-<td><tt>editable</tt></td>
+<td>editable</td>
-<td><tt>@readonly</tt></td>
+<td>@readonly</td>
<td>No</td>
@@ -1055,9 +1041,9 @@
<tr class="b">
-<td><tt>required</tt></td>
+<td>required</td>
-<td><tt>@required</tt></td>
+<td>@required</td>
<td>No</td>
@@ -1072,7 +1058,7 @@
<tr class="a">
-<td><tt>description</tt></td>
+<td>description</td>
<td>none (detected)</td>
@@ -1087,7 +1073,7 @@
<tr class="b">
-<td><tt>name</tt></td>
+<td>name</td>
<td>none (detected)</td>
@@ -1101,7 +1087,7 @@
<tr class="a">
-<td><tt>type</tt></td>
+<td>type</td>
<td>none (detected)</td>
@@ -1118,9 +1104,9 @@
<tr class="b">
-<td><tt>deprecated</tt></td>
+<td>deprecated</td>
-<td><tt>@deprecated <deprecated-text></tt></td>
+<td>@deprecated <deprecated-text></td>
<td>No</td>
@@ -1131,9 +1117,9 @@
<tr class="a">
-<td><tt>since</tt></td>
+<td>since</td>
-<td><tt>@since <since-text></tt></td>
+<td>@since <since-text></td>
<td>No</td>
@@ -1152,9 +1138,8 @@
plugin descriptor are assumed to be runtime, because this is a
runtime profile for the plugin).
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="Plugin_Tools"></a>Plugin Tools</h2>
<p>By now, we've mentioned the plugin tools several times without telling
@@ -1169,9 +1154,8 @@
enabling richer interactions between the Mojo and the user. The
section below describes the changes to the POM which are necessary to
create plugin artifacts.</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="Project_Descriptor_.28POM.29_Requirements"></a>Project Descriptor (POM) Requirements</h2>
<p>From the POM, Maven plugin projects look quite similar to any other
@@ -1199,9 +1183,9 @@
<td>Yes</td>
<td>
- <tt><packaging>
+ <packaging>
maven-plugin
- </packaging></tt>
+ </packaging>
</td>
<td>The POM must declare a packaging element which describes this
@@ -1215,16 +1199,16 @@
<td>No</td>
<td>
- <tt><scriptSourceDirectory>
+ <scriptSourceDirectory>
src/main/scripts
- </scriptSourceDirectory></tt>
+ </scriptSourceDirectory>
</td>
<td>In the case of script-based Mojos (which are not covered in
detail within this document), the POM must include an additional
element to distinguish script sources from (optional) Java
- supporting classes. This element is <tt>scriptSourceDirectory</tt>,
- inside the <tt>build</tt> section. This directory is included in the list
+ supporting classes. This element is scriptSourceDirectory,
+ inside the build section. This directory is included in the list
of resources which accompany any compiled code in the resulting
artifact. It is specified separately from the resources in the
build section to denote its special status as an alternate source
@@ -1241,9 +1225,8 @@
the local repository. (Any of the other standard lifecycle targets like
package, deploy, etc. are also available in like fashion.)
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="IDE_integration"></a>IDE integration</h2>
<p>If you're using JetBrains IntelliJ IDEA to develop your plugin,
@@ -1253,7 +1236,7 @@
<ol style="list-style-type: decimal">
<li>Download <a href="./maven.xml">this file</a>,
- and place it in <tt>$USER_HOME/.IntelliJIdea/config/templates</tt></li>
+ and place it in $USER_HOME/.IntelliJIdea/config/templates</li>
<li>(re)startup IntelliJ IDEA (templates are loaded on startup)</li>
@@ -1268,9 +1251,8 @@
</ul>
</li>
</ol>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="Resources"></a>Resources</h2>
<p>This section simply gives a listing of pointers for more
@@ -1298,7 +1280,7 @@
]
</li>
</ul>
- </div>
+ </section>
</div>
Modified: maven/website/content/developers/release/index.html
==============================================================================
--- maven/website/content/developers/release/index.html (original)
+++ maven/website/content/developers/release/index.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/developers/release/index.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/developers/release/index.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">
@@ -137,7 +137,7 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Releasing_A_Maven_Project"></a>Releasing A Maven Project</h2>
<p>What follows is a description of releasing a Maven project to a staging repository and its documentation, whereupon it is scrutinized by the community, approved, and transferred to a production repository.</p>
<p>The steps involved are similar for any Apache project, with more specifics for parent POMs and Maven itself. The steps involved, and the relevant documents for each, are listed below.</p>
@@ -146,7 +146,7 @@
<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul>
<p>The above links all provide specific information for those types of releases, but they all refer back to the common documentation:</p>
<ul>
-<li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul></div>
+<li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul></section>
</div>
</div>
</div>
Modified: maven/website/content/developers/release/maven-core-release.html
==============================================================================
--- maven/website/content/developers/release/maven-core-release.html (original)
+++ maven/website/content/developers/release/maven-core-release.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/markdown/developers/release/maven-core-release.md at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/markdown/developers/release/maven-core-release.md 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">
@@ -135,18 +135,17 @@
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Releasing_Maven"></a>Releasing Maven</h2>
<p>Maven differs slightly in its release process due to several extra steps.</p>
-<p>The goal is to commit candidate release to svn tree <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/maven/maven-3">https://dist.apache.org/repos/dist/dev/maven/maven-3</a>/<tt>$VERSION</tt>. Then once the vote passed, svn move to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/maven-3">https://dist.apache.org/repos/dist/release/maven/maven-3</a>/<tt>$VERSION</tt>.</p>
+<p>The goal is to commit candidate release to svn tree <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/maven/maven-3">https://dist.apache.org/repos/dist/dev/maven/maven-3</a>/$VERSION. Then once the vote passed, svn move to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/maven-3">https://dist.apache.org/repos/dist/release/maven/maven-3</a>/$VERSION.</p>
<p>The tree directory is:</p>
<ul>
-<li><a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/maven-3/">https://dist.apache.org/repos/dist/release/maven/maven-3/</a><tt>$VERSION</tt>/binaries</li>
-<li><a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/maven-3/">https://dist.apache.org/repos/dist/release/maven/maven-3/</a><tt>$VERSION</tt>/source</li>
+<li><a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/maven-3/">https://dist.apache.org/repos/dist/release/maven/maven-3/</a>$VERSION/binaries</li>
+<li><a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven/maven-3/">https://dist.apache.org/repos/dist/release/maven/maven-3/</a>$VERSION/source</li>
</ul>
-<p>Note that the policy for failed releases is to move forward with a new version. The tag that produced the failed released is left in place for posterity. So if the release of, say, 3.2.4 fails then we move forward with 3.2.5.</p>
-<div class="section">
+<p>Note that the policy for failed releases is to move forward with a new version. The tag that produced the failed released is left in place for posterity. So if the release of, say, 3.2.4 fails then we move forward with 3.2.5.</p><section>
<h3><a name="Produce_Release_Candidates"></a>Produce Release Candidates</h3>
<p>For non-alpha/beta releases, release candidates are produced before the actual release.</p>
<p>Checkout <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/maven/maven-3">https://dist.apache.org/repos/dist/dev/maven/maven-3</a> then create the necessary directory tree.</p>
@@ -159,35 +158,31 @@
<p>The version used should be the eventual version with -RC1, -RC2, etc. appended.</p>
<p>After producing the RC, request that the developers test the release on the list. If a regression is found, a new release candidate is rolled.</p>
<p>After a reasonable time without regressions found, a wider audience may be polled if the release manager desires (for example, users@).</p>
-<p>Once happy with a release candidate, the full release is performed, with the final version in place.</p></div>
-<div class="section">
+<p>Once happy with a release candidate, the full release is performed, with the final version in place.</p></section><section>
<h3><a name="Produce_the_Release"></a>Produce the Release</h3>
<p>To produce a final release, the same process as for standard projects is followed:</p>
<ul>
<li><a href="./maven-project-release-procedure.html">Maven Project Common Release Procedure</a></li>
</ul>
-<p>Below describes the additional steps that need to be taken at the points where the website are updated in those instructions.</p>
-<div class="section">
+<p>Below describes the additional steps that need to be taken at the points where the website are updated in those instructions.</p><section>
<h4><a name="Update_the_DOAP_Information"></a>Update the DOAP Information</h4>
-<p>Edit <a class="externalLink" href="https://github.com/apache/maven/blob/master/doap_Maven.rdf">https://github.com/apache/maven/blob/master/doap_Maven.rdf</a> to list the new release.</p></div>
-<div class="section">
+<p>Edit <a class="externalLink" href="https://github.com/apache/maven/blob/master/doap_Maven.rdf">https://github.com/apache/maven/blob/master/doap_Maven.rdf</a> to list the new release.</p></section><section>
<h4><a name="Update_the_Release_Notes_and_Web_Site"></a>Update the Release Notes and Web Site</h4>
<p>Checkout <a class="externalLink" href="https://svn.apache.org/repos/asf/maven/site/trunk">https://svn.apache.org/repos/asf/maven/site/trunk</a>.</p>
<p>Note that release notes can be created and checked in, but other changes should not be checked in as it can be deployed ‘live’ at any time.</p>
<ul>
-<li>For 3.x: update the <tt>versions3x</tt>, <tt>currentStableVersion</tt> and <tt>currentStableReleaseDate</tt> properties in <tt>pom.xml</tt></li>
+<li>For 3.x: update the versions3x, currentStableVersion and currentStableReleaseDate properties in pom.xml</li>
</ul>
<p>Next, create the release notes:</p>
<ul>
-<li>create <tt>content/markdown/docs/$version</tt></li>
-<li>create <tt>content/markdowndocs/$version/release-notes.md</tt> (see other versions for an example)</li>
+<li>create content/markdown/docs/$version</li>
+<li>create content/markdowndocs/$version/release-notes.md (see other versions for an example)</li>
</ul>
-<p>Next, update release history <tt>content/markdown/docs/history.md.vm</tt>.</p>
-<p>Only deploy the site once the release is present on the mirrors, and the reference documentation has been deployed to <a href="/ref">/ref/</a>.</p></div>
-<div class="section">
+<p>Next, update release history content/markdown/docs/history.md.vm.</p>
+<p>Only deploy the site once the release is present on the mirrors, and the reference documentation has been deployed to <a href="/ref">/ref/</a>.</p></section><section>
<h4><a name="Stage_the_Latest_Documentation"></a>Stage the Latest Documentation</h4>
<p>Once the release is prepared, but before the release vote, the site needs to be staged.</p>
<p>From the release checkout, stage the site:</p>
@@ -198,8 +193,7 @@
mvn scm-publish:publish-scm
</pre></div></div>
-<p>This will publish the site in <a href="/ref/3-LATEST">/ref/3-LATEST</a>.</p></div>
-<div class="section">
+<p>This will publish the site in <a href="/ref/3-LATEST">/ref/3-LATEST</a>.</p></section><section>
<h4><a name="Add_New_Version_to_ASF_Distribution_Directory"></a>Add New Version to ASF Distribution Directory</h4>
<p>In addition to promoting the repository, the release archives should be moved to the release svnpubsub tree:</p>
@@ -207,30 +201,25 @@ mvn scm-publish:publish-scm
<div>
<pre class="source">svn mv https://dist.apache.org/repos/dist/dev/maven/maven-3/$VERSION https://dist.apache.org/repos/dist/release/maven/maven-3
</pre></div></div>
-</div>
-<div class="section">
+</section><section>
<h4><a name="Deploy_the_Current_Reference"></a>Deploy the Current Reference</h4>
<p>The source code references and API docs need to be deployed before deploying the web site with the new version.</p>
-<p>This consists in copying in website svn tree the /ref/3-LATEST directory to /ref/<tt>$VERSION</tt>.</p>
+<p>This consists in copying in website svn tree the /ref/3-LATEST directory to /ref/$VERSION.</p>
<div>
<div>
<pre class="source">svn cp https://svn.apache.org/repos/infra/websites/production/maven/components/ref/3-LATEST https://svn.apache.org/repos/infra/websites/production/maven/components/ref/$VERSION
</pre></div></div>
-</div></div>
-<div class="section">
-<h3><a name="Information_on_.2Fref.2Fcurrent_mechanism"></a>Information on <tt>/ref/current</tt> mechanism</h3>
-<p>The redirection from <tt>/ref/current</tt> to actual Maven version reference is done through <tt>.htaccess</tt> published in site.</p>
-<div class="section">
+</section></section><section>
+<h3><a name="Information_on_.2Fref.2Fcurrent_mechanism"></a>Information on /ref/current mechanism</h3>
+<p>The redirection from /ref/current to actual Maven version reference is done through .htaccess published in site.</p><section>
<h4><a name="Deploying_the_Release_Website"></a>Deploying the Release Website</h4>
<p>Once both of the above have synced to the main site and a suitable number of mirrors, proceed to update the web site and produce the announcement.</p>
-<p>Commit your changes and then <a href="../website/deploy-maven-website.html">deploy the main Maven site</a>.</p></div>
-<div class="section">
+<p>Commit your changes and then <a href="../website/deploy-maven-website.html">deploy the main Maven site</a>.</p></section><section>
<h4><a name="Remove_Old_Versions_from_ASF_Distribution_Directory"></a>Remove Old Versions from ASF Distribution Directory</h4>
-<p>Next, any superceded releases should be removed from the above locations (after confirming that they exist in /www/archive.apache.org/dist/maven).</p></div>
-<div class="section">
+<p>Next, any superceded releases should be removed from the above locations (after confirming that they exist in /www/archive.apache.org/dist/maven).</p></section><section>
<h4><a name="Proceed_with_Announcement"></a>Proceed with Announcement</h4>
-<p>You can now proceed with the steps outlined after deploying the website on <a href="./maven-project-release-procedure.html">Maven Project Common Release Procedure</a></p></div></div></div>
+<p>You can now proceed with the steps outlined after deploying the website on <a href="./maven-project-release-procedure.html">Maven Project Common Release Procedure</a></p></section></section></section>
</div>
</div>
</div>
Modified: maven/website/content/developers/release/maven-project-release-procedure.html
==============================================================================
--- maven/website/content/developers/release/maven-project-release-procedure.html (original)
+++ maven/website/content/developers/release/maven-project-release-procedure.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/developers/release/maven-project-release-procedure.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/developers/release/maven-project-release-procedure.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">
@@ -138,36 +138,30 @@ Karl Heinz Marbaise" />
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Performing_a_Maven_Project_Release"></a>Performing a Maven Project Release</h2>
-<p>This document covers the common release procedures used by the Maven team to perform releases.</p>
-<div class="section">
+<p>This document covers the common release procedures used by the Maven team to perform releases.</p><section>
<h3><a name="Prerequisites">Prerequisites</a></h3>
<p>Be sure that:</p>
<ul>
<li>you have a Subversion 1.5+ client installed and on your shell's path. See <a class="externalLink" href="https://subversion.apache.org/">https://subversion.apache.org/</a>.</li>
<li>you have JDK 5 installed and on your shell's path.</li>
-<li>if you receive an OutOfMemoryError during the build, make sure to have set the environment variable <tt>MAVEN_OPTS=-Xmx512m</tt></li>
+<li>if you receive an OutOfMemoryError during the build, make sure to have set the environment variable <code>MAVEN_OPTS=-Xmx512m</code></li>
<li>you must use Maven 2.2.1+, as Maven 2.1.0 and 2.2.0 produce incorrect GPG signatures and checksums respectively.</li>
-<li>follow Apache environment configuration steps outlined at: <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#dev-env">Publishing Maven Artifacts</a>.</li></ul></div>
-<div class="section">
+<li>follow Apache environment configuration steps outlined at: <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#dev-env">Publishing Maven Artifacts</a>.</li></ul></section><section>
<h3><a name="Before_you_begin"></a>Before you begin</h3>
<p>If you started here, you may first want to review one of the following documents that cover the specifics of various types of releases we have in the Maven Project:</p>
<ul>
<li><a href="./maven-core-release.html"> Releasing Maven Core</a></li>
-<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul></div>
-<div class="section">
+<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul></section><section>
<h3><a name="Consider_updating_the_parent_versions"></a>Consider updating the parent versions</h3>
-<p>If the item you are planning to release is not using the most recent version of its parent (see <a href="../../pom/">parent POMs</a> index), consider taking this opportunity to update to it.</p></div>
-<div class="section">
+<p>If the item you are planning to release is not using the most recent version of its parent (see <a href="../../pom/">parent POMs</a> index), consider taking this opportunity to update to it.</p></section><section>
<h3><a name="Make_sure_that_site_compilation_and_publication_works"></a>Make sure that site compilation and publication works</h3>
-<p>Particularly if you update the parent (but sometimes under other circumstances), the site compilation process may fail, or reveal a conspicuous error, or deploy to the wrong location. It is stressful and time-consuming to discover this *after* you stage a release and then try to follow the procedure to deploy the site for review. So you may find it more pleasant to check out the state of the site before you start.</p></div>
-<div class="section">
+<p>Particularly if you update the parent (but sometimes under other circumstances), the site compilation process may fail, or reveal a conspicuous error, or deploy to the wrong location. It is stressful and time-consuming to discover this *after* you stage a release and then try to follow the procedure to deploy the site for review. So you may find it more pleasant to check out the state of the site before you start.</p></section><section>
<h3><a name="Stage_the_Release"></a>Stage the Release</h3>
<ol style="list-style-type: decimal">
<li>Follow the release preparation, staging and closing the repository steps outlined in <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#staging-maven">Staging a Maven release</a>. </li>
-<li>Stage the latest documentation as explained in <a href="../website/deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>.</li></ol></div>
-<div class="section">
+<li>Stage the latest documentation as explained in <a href="../website/deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>.</li></ol></section><section>
<h3><a name="Call_the_vote"></a>Call the vote</h3>
<p>Propose a vote on the dev list with the closed issues, the issues left, the staging repository and the staging site. For instance:</p>
<div class="source"><pre class="prettyprint linenums">To: "Maven Developers List" <dev@maven.apache.org>
@@ -202,8 +196,7 @@ Vote open for at least 72 hours.
</pre></div>
<p>To get the JIRA release notes link, browse to the plugin's JIRA page, select the <i>Road Map</i> link, and use the link to <i>Release Notes</i> that is next to the version being released.</p>
<p>To get the list of issues left in JIRA, browse to the plugin's JIRA page, and from the <i>Preset Filters</i> on the right, use the link for <i>Outstanding</i> issues.</p>
-<p>The vote is open for at least 72 hours means, that you need to wait at least 72 hours before proceeding. This gives others time to test your release and check that everything is good. If you have received after that not enough +1 votes to reach the quorum, this doesn't mean, the vote failed. It just takes a bit longer.</p></div>
-<div class="section">
+<p>The vote is open for at least 72 hours means, that you need to wait at least 72 hours before proceeding. This gives others time to test your release and check that everything is good. If you have received after that not enough +1 votes to reach the quorum, this doesn't mean, the vote failed. It just takes a bit longer.</p></section><section>
<h3><a name="Check_the_vote_results"></a>Check the vote results</h3>
<p>Copied from <a class="externalLink" href="https://www.apache.org/foundation/voting.html#ReleaseVotes">Votes on Package Releases</a>.</p>
<div class="source"><pre class="prettyprint linenums">Votes on whether a package is ready to be released use majority approval
@@ -228,19 +221,17 @@ The vote has passed with the following r
PMC quorum: ...
I will promote the artifacts to the central repo.</pre></div>
-<p>If the vote is unsuccessful, the process will need to be restarted. Be sure to drop your staging repository as described in <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#drop">Dropping a Repo</a>.</p></div>
-<div class="section">
+<p>If the vote is unsuccessful, the process will need to be restarted. Be sure to drop your staging repository as described in <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#drop">Dropping a Repo</a>.</p></section><section>
<h3><a name="Copy_the_source_release_to_the_Apache_Distribution_Area"></a>Copy the source release to the Apache Distribution Area</h3>
-<p>The official Apache release is the 'source-release' bundle distributed in <tt>www.apache.org/dist</tt>, as described in <a class="externalLink" href="http://www.apache.org/dev/release-distribution">Apache release distribution policy</a>. All releases for Maven must be copied to <a class="externalLink" href="https://www.apache.org/dist/maven/">the official Maven release area</a>.</p>
-<p>The release area is maintained with svnsubpub. To deliver a release, you add it to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven">the subversion repository for the dist area</a>: add the release, its signature and sha512 checksum files, copying them from <tt>target/checkout/target/</tt> directory created during <tt>mvn release:perform</tt> step. Currently this requires to be in maven-pmc group (see <a class="externalLink" href="https://issues.apache.org/jira/browse/INFRA-5945">https://issues.apache.org/jira/browse/INFRA-5945</a>). If you are not PMC member, drop a line to <i>private@maven.apache.org</i> and ask them to do this step for you: the PMC member will get the source release bundle and its signature from Nexus staging repository and will create sha512 checksum file by hand.</p>
+<p>The official Apache release is the 'source-release' bundle distributed in <code>www.apache.org/dist</code>, as described in <a class="externalLink" href="http://www.apache.org/dev/release-distribution">Apache release distribution policy</a>. All releases for Maven must be copied to <a class="externalLink" href="https://www.apache.org/dist/maven/">the official Maven release area</a>.</p>
+<p>The release area is maintained with svnsubpub. To deliver a release, you add it to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven">the subversion repository for the dist area</a>: add the release, its signature and sha512 checksum files, copying them from <code>target/checkout/target/</code> directory created during <code>mvn release:perform</code> step. Currently this requires to be in maven-pmc group (see <a class="externalLink" href="https://issues.apache.org/jira/browse/INFRA-5945">https://issues.apache.org/jira/browse/INFRA-5945</a>). If you are not PMC member, drop a line to <i>private@maven.apache.org</i> and ask them to do this step for you: the PMC member will get the source release bundle and its signature from Nexus staging repository and will create sha512 checksum file by hand.</p>
<p>For example:</p>
<div class="source"><pre class="prettyprint linenums">wagon/wagon-2.2-source-release.zip
wagon/wagon-2.2-source-release.zip.asc
wagon/wagon-2.2-source-release.zip.sha512</pre></div>
<p>You should also run 'svn rm' as needed to clear out older releases. As per <a class="externalLink" href="https://www.apache.org/dev/release.html#where-do-releases-go">the release policy</a>, only the latest release on a branch should stay in the main dist areas. So long as the previous release is at least a day old, the automatic archiver will have copied it to the archive.</p>
<p>To check that everything is ok in the dist area, dist-tool-plugin has been written and run once a day to produce <a class="externalLink" href="https://builds.apache.org/view/M-R/view/Maven/job/dist-tool-plugin/site/dist-tool-check-source-release.html">"Disttool> Source Release" report</a>.</p>
-<p>After committing the 3 source-release files, visit <a class="externalLink" href="https://reporter.apache.org/addrelease.html?maven">Apache Committee Report Helper</a> to add your release data with the Full Version Name and Date of Release. (You will receive an e-mail for it as well).</p></div>
-<div class="section">
+<p>After committing the 3 source-release files, visit <a class="externalLink" href="https://reporter.apache.org/addrelease.html?maven">Apache Committee Report Helper</a> to add your release data with the Full Version Name and Date of Release. (You will receive an e-mail for it as well).</p></section><section>
<h3><a name="Promote_the_release"></a>Promote the release</h3>
<p>Once the release is deemed fit for public consumption it can be transfered to a production repository where it will be available to all users.</p>
<ol style="list-style-type: decimal">
@@ -249,7 +240,7 @@ wagon/wagon-2.2-source-release.zip.sha51
<p>As above, deploy the web site if appropriate and update the project site for the new release: use <a href="../website/component-reference-documentation-helper.html">Component Reference Documentation Helper</a> to generate commands or see <a href="../website/deploy-component-reference-documentation.html#Publishing_versioned_component_reference_documentation">Publishing versioned component reference documentation</a> for explanations. Note that not all projects follow these conventions exactly.</p>
<p>In case there's an overview table with version (e.g. <a href="/plugins/index.html">plugins</a> and <a href="/shared/index.html">shared</a>) you can directly edit it on the github page.</p></li>
<li>Update the version tracking in JIRA
-<p>In the relevant project, go to Administration, then Versions. Mark the <tt>Y.Z</tt> version as 'released'. Create version <tt>Y.Z+1</tt>, if that hasn't already been done. You may also archive any deprecated releases (milestones or alphas) at this time.</p>
+<p>In the relevant project, go to Administration, then Versions. Mark the <code>Y.Z</code> version as 'released'. Create version <code>Y.Z+1</code>, if that hasn't already been done. You may also archive any deprecated releases (milestones or alphas) at this time.</p>
<p>Note: Currently this requires to be in the maven-pmc group. So, if you don't see the Administration option in JIRA, kindly ask <i>private@maven.apache.org</i> to do this step for you.</p></li>
<li>Wait for everything to sync
<ol style="list-style-type: lower-alpha">
@@ -263,7 +254,7 @@ wagon/wagon-2.2-source-release.zip.sha51
<p>If you are releasing a plugin or a shared component you can let Maven Changes Plugin <b>generate</b>, and eventually even <b>send</b>, the announcement for you. First make sure that you have configured the necessary properties in your <a href="../committer-settings.html">committer settings</a>.</p>
<div class="source"><pre class="prettyprint linenums">cd target/checkout
mvn changes:announcement-mail -Papache-release</pre></div>
-<p>If sending the mail should fail, the generated annoucement is available in <tt>target/annoucement</tt> (see <tt>annoucement.vm</tt>) and you can use it as a base for sending the mail manually.</p>
+<p>If sending the mail should fail, the generated annoucement is available in <code>target/annoucement</code> (see <code>annoucement.vm</code>) and you can use it as a base for sending the mail manually.</p>
<p>If your SMTP server requires authentication you need to add the command line options for it:</p>
<div class="source"><pre class="prettyprint linenums">cd target/checkout
mvn changes:announcement-mail -Dchanges.username=<SMTP-USERNAME> -Dchanges.password=<SMTP-PASSWORD> -Papache-release</pre></div></li>
@@ -303,7 +294,7 @@ Enjoy,
<li>If releasing the Apache Parent POM, notify release-discuss@apache.org
<p>Several projects follow this list, and should be made aware of changes to the common parent. This might also be a step to take if other shared resources are released, or if plugin releases are of particular interest to that group.</p>
<p>If releasing Maven Core, notify announce@apache.org</p></li>
-<li>Celebrate :o)</li></ol></div></div>
+<li>Celebrate :o)</li></ol></section></section>
</div>
</div>
</div>
Modified: maven/website/content/developers/release/parent-pom-release.html
==============================================================================
--- maven/website/content/developers/release/parent-pom-release.html (original)
+++ maven/website/content/developers/release/parent-pom-release.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/developers/release/parent-pom-release.apt at 2019-06-09
+ | Generated by Apache Maven Doxia Site Renderer 1.9 from content/apt/developers/release/parent-pom-release.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">
@@ -138,15 +138,14 @@ Dennis Lundberg" />
</div>
</div>
<div id="bodyColumn" class="span10" >
-<div class="section">
+<section>
<h2><a name="Releasing_A_Parent_POM"></a>Releasing A Parent POM</h2>
<p>Releasing a Parent POM is much the same as any other Maven project. The following guide walks through most of the steps:</p>
<ul>
<li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul>
-<p>Note that Parent POMs have particular conventions for managing and deploying the documentation.</p>
-<div class="section">
+<p>Note that Parent POMs have particular conventions for managing and deploying the documentation.</p><section>
<h3><a name="Rationale"></a>Rationale</h3>
-<p>To be able to publish a documentation for the parent POM without affecting released <tt>pom.xml</tt> and <tt>site.xml</tt>, parent POM projects have a specific structure, with the addition of <tt>site-pom.xml</tt> and <tt>src/site-docs</tt> to provide <tt>mvn -f site-pom.xml site</tt> with useful documentation content:</p>
+<p>To be able to publish a documentation for the parent POM without affecting released <code>pom.xml</code> and <code>site.xml</code>, parent POM projects have a specific structure, with the addition of <code>site-pom.xml</code> and <code>src/site-docs</code> to provide <code>mvn -f site-pom.xml site</code> with useful documentation content:</p>
<div class="source"><pre class="prettyprint linenums">|-- pom.xml
|-- site-pom.xml
`-- src
@@ -156,23 +155,21 @@ Dennis Lundberg" />
|-- apt
| `-- index.apt
`-- site.xml</pre></div>
-<p>And the <tt>index.apt</tt> page not only contains instructions about the content of the parent POM, but it maintains a history of POM releases links and diffs.</p>
-<p>Each specific step is done to maintain <tt>site-pom.xml</tt> and <tt>index.apt</tt> in sync with the release being released.</p></div>
-<div class="section">
+<p>And the <code>index.apt</code> page not only contains instructions about the content of the parent POM, but it maintains a history of POM releases links and diffs.</p>
+<p>Each specific step is done to maintain <code>site-pom.xml</code> and <code>index.apt</code> in sync with the release being released.</p></section><section>
<h3><a name="Stage_the_release"></a>Stage the release</h3>
-<p>Before staging the release with usual procedure, you need to update <tt>site-pom.xml</tt> and <tt>index.apt</tt> to take the future release into account:</p>
+<p>Before staging the release with usual procedure, you need to update <code>site-pom.xml</code> and <code>index.apt</code> to take the future release into account:</p>
<ol style="list-style-type: decimal">
-<li>update <tt>site-pom.xml</tt> parent POM version to match the version being released,</li>
-<li>update <tt>src/site-docs/index.apt.vm</tt>: add a line in the history of <tt>pom.xml</tt> for the version being released, referring to the future svn release tag and date.
-<p><b>Hint</b>: in the diff link, the value for the <tt>r2</tt> parameter is easily found by following the previous version's link and copying its revision number.</p></li></ol>
-<p>Once these modifications are done, you can follow <a href="../website/deploy-component-reference-documentation.html">standard component documentation staging steps</a>, taking care to use the <tt>site-pom.xml</tt> POM, with <tt>mvn -f site-pom.xml ...</tt> command, each time the parent POM's site is generated or published.</p>
+<li>update <code>site-pom.xml</code> parent POM version to match the version being released,</li>
+<li>update <code>src/site-docs/index.apt.vm</code>: add a line in the history of <code>pom.xml</code> for the version being released, referring to the future svn release tag and date.
+<p><b>Hint</b>: in the diff link, the value for the <code>r2</code> parameter is easily found by following the previous version's link and copying its revision number.</p></li></ol>
+<p>Once these modifications are done, you can follow <a href="../website/deploy-component-reference-documentation.html">standard component documentation staging steps</a>, taking care to use the <code>site-pom.xml</code> POM, with <code>mvn -f site-pom.xml ...</code> command, each time the parent POM's site is generated or published.</p>
<p>Then the only difference is with commands to stage the site:</p>
<div class="source"><pre class="prettyprint linenums">cd target/checkout
mvn -f site-pom.xml site
-mvn -f site-pom.xml scm-publish:publish-scm</pre></div></div>
-<div class="section">
+mvn -f site-pom.xml scm-publish:publish-scm</pre></div></section><section>
<h3><a name="Call_the_vote"></a>Call the vote</h3>
-<p>In the vote, instead of providing links to JIRA, the parent POMs should include a link to the SVN changes since the last release (the link previously added to <tt>src/site-docs/index.apt</tt>):</p>
+<p>In the vote, instead of providing links to JIRA, the parent POMs should include a link to the SVN changes since the last release (the link previously added to <code>src/site-docs/index.apt</code>):</p>
<div class="source"><pre class="prettyprint linenums">...
Hi,
@@ -180,7 +177,7 @@ Changes since the last release:
https://svn.apache.org/viewvc/maven/pom/tags/<TAG>/pom.xml?r1=HEAD&r2=<REVISION-OF-LAST-RELEASE>&diff_format=h
Staging repo:
-...</pre></div></div></div>
+...</pre></div></section></section>
</div>
</div>
</div>