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 2018/07/21 16:17:25 UTC
svn commit: r1836411 - in /maven/website/content: ./ developers/conventions/
plugin-developers/cookbook/
Author: svn-site-role
Date: Sat Jul 21 16:17:24 2018
New Revision: 1836411
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/developers/conventions/code.html
maven/website/content/install.html
maven/website/content/maven-jsr330.html
maven/website/content/maven-site-1.0-site.jar
maven/website/content/plugin-developers/cookbook/add-build-time-to-manifest.html
maven/website/content/plugin-developers/cookbook/add-svn-revision-to-manifest.html
maven/website/content/plugin-developers/cookbook/attach-source-javadoc-artifacts.html
maven/website/content/plugin-developers/cookbook/generate-assembly.html
maven/website/content/plugin-developers/cookbook/index.html
maven/website/content/plugin-developers/cookbook/plexus-plugin-upgrade.html
Modified: maven/website/content/developers/conventions/code.html
==============================================================================
--- maven/website/content/developers/conventions/code.html (original)
+++ maven/website/content/developers/conventions/code.html Sat Jul 21 16:17:24 2018
@@ -318,7 +318,7 @@
<li>The <project/> element is always on one line.</li>
<li>The blocks are voluntary separated by a new line to improve the readingness.</li>
<li>The dependencies in <dependencies/> and <dependencyManagement/> tags have no specific ordering. Developers are free to choose the ordering, but grouping dependencies by topics (like groupId i.e. <tt>org.apache.maven</tt>) is a good practice.</li></ol>
-<p><b>Note</b>: There existing two alternativs to change order of a pom file <a class="externalLink" href="https://www.mojohaus.org/tidy-maven-plugin/">Tidy Maven Plugin</a> or the <a class="externalLink" href="https://code.google.com/p/sortpom/">maven-sortpom-plugin</a>. </p></div>
+<p><b>Note</b>: There existing two alternativs to change order of a pom file <a class="externalLink" href="https://www.mojohaus.org/tidy-maven-plugin/">Tidy Maven Plugin</a> or the <a class="externalLink" href="https://github.com/Ekryd/sortpom"></a>.</p></div>
<div class="section">
<h4><a name="XDOC_Code_Convention">XDOC Code Convention</a></h4>
<p>For consistency and readability reasons, XDOC files should respect:</p>
Modified: maven/website/content/install.html
==============================================================================
--- maven/website/content/install.html (original)
+++ maven/website/content/install.html Sat Jul 21 16:17:24 2018
@@ -168,7 +168,7 @@
<div>
<div>
-<pre class="source">Apache Maven 3.5.4 (138edd61fd100ec658bfa2d307c43b76940a5d7d; 2017-10-18T08:58:13+01:00)
+<pre class="source">Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T20:33:14+02:00)
Maven home: /opt/apache-maven-3.5.4
Java version: 1.8.0_45, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk/Contents/Home/jre
Modified: maven/website/content/maven-jsr330.html
==============================================================================
--- maven/website/content/maven-jsr330.html (original)
+++ maven/website/content/maven-jsr330.html Sat Jul 21 16:17:24 2018
@@ -61,7 +61,28 @@
<li><a href="plugins/index.html" title="Maven Plugins"><span class="none"></span>Maven Plugins</a></li>
<li><a href="guides/index.html" title="Index (category)"><span class="none"></span>Index (category)</a></li>
<li><a href="users/index.html" title="User Centre"><span class="icon-chevron-right"></span>User Centre</a></li>
- <li><a href="plugin-developers/index.html" title="Plugin Developer Centre"><span class="icon-chevron-right"></span>Plugin Developer Centre</a></li>
+ <li><a href="plugin-developers/index.html" title="Plugin Developer Centre"><span class="icon-chevron-down"></span>Plugin Developer Centre</a>
+ <ul class="nav nav-list">
+ <li><a href="guides/introduction/introduction-to-plugins.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="guides/plugin/guide-java-plugin-development.html" title="Your First Mojo"><span class="none"></span>Your First Mojo</a></li>
+ <li><a href="guides/plugin/guide-java-report-plugin-development.html" title="Your First Report Mojo"><span class="none"></span>Your First Report Mojo</a></li>
+ <li><a href="plugin-developers/plugin-testing.html" title="Testing Plugins"><span class="none"></span>Testing Plugins</a></li>
+ <li><a href="plugin-developers/plugin-documenting.html" title="Documenting Plugins"><span class="none"></span>Documenting Plugins</a></li>
+ <li><a href="plugin-developers/cookbook/index.html" title="Plugins Cookbook"><span class="icon-chevron-down"></span>Plugins Cookbook</a>
+ <ul class="nav nav-list">
+ <li><a href="plugin-developers/cookbook/add-build-time-to-manifest.html" title="Build Time"><span class="none"></span>Build Time</a></li>
+ <li><a href="plugin-developers/cookbook/add-svn-revision-to-manifest.html" title="SVN Revision"><span class="none"></span>SVN Revision</a></li>
+ <li><a href="plugin-developers/cookbook/attach-source-javadoc-artifacts.html" title="Attach Source + Javadoc"><span class="none"></span>Attach Source + Javadoc</a></li>
+ <li><a href="plugin-developers/cookbook/generate-assembly.html" title="Assembly"><span class="none"></span>Assembly</a></li>
+ <li><a href="plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Plexus Annotations"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Using JSR-330</a></li>
+ </ul>
+</li>
+ <li><a href="developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
+ <li><a href="plugin-developers/common-bugs.html" title="Common Bugs and Pitfalls"><span class="none"></span>Common Bugs and Pitfalls</a></li>
+ <li><a href="examples/maven-3-lifecycle-extensions.html" title="Maven Lifecycle Extensions"><span class="none"></span>Maven Lifecycle Extensions</a></li>
+ </ul>
+</li>
<li><a href="repository/index.html" title="Maven Central Repository"><span class="icon-chevron-right"></span>Maven Central Repository</a></li>
<li><a href="developers/index.html" title="Maven Developer Centre"><span class="icon-chevron-right"></span>Maven Developer Centre</a></li>
<li><a href="articles.html" title="Books and Resources"><span class="none"></span>Books and Resources</a></li>
@@ -122,7 +143,7 @@
<div class="section">
<h2><a name="Why_JSR-330.3F"></a>Why JSR-330?</h2>
<p>Maven has a long history of using dependency injection (DI) by way of <a class="externalLink" href="https://codehaus-plexus.github.io/">Plexus</a>, so the intent of using <a class="externalLink" href="https://www.jcp.org/en/jsr/detail?id=330">JSR-330</a> is to replace a custom DI mechanism with something standard. The implementation Maven uses - since 3.0-beta-3 - is based on <a class="externalLink" href="https://code.google.com/p/google-guice/">Guice 3.x</a>, which directly supports JSR-330.</p>
-<p>If you are using <a class="externalLink" href="https://github.com/sonatype/plexus-containers">Plexus annotations and APIs</a> currently, there is no rush to switch and no big bang conversions are necessary: Plexus, JSR-330 and Guice APIs all happily co-exist within Maven's core and you can choose to use JSR-330 when you wish. There are hundreds of components written using the Plexus APIs, particularly components and plugins compatible with Maven 2, then those APIs will be supported forever, or at least until Maven fully drops Maven 2 support.</p>
+<p>If you are using <a class="externalLink" href="https://codehaus-plexus.github.io/plexus-containers/">Plexus annotations and APIs</a> currently, there is no rush to switch and no big bang conversions are necessary: Plexus, JSR-330 and Guice APIs all happily co-exist within Maven's core and you can choose to use JSR-330 when you wish. There are hundreds of components written using the Plexus APIs, particularly components and plugins compatible with Maven 2, then those APIs will be supported forever, or at least until Maven fully drops Maven 2 support.</p>
<p>If you want to use JSR-330, you must understand that your code won't be compatible with Maven 2 or 3.0.x but only with Maven 3.1.0+: even if JSR-330 is available in core since Maven 3.0-beta-3, it was made available to plugins and extensions only in Maven 3.1.0 (see <a class="externalLink" href="https://issues.apache.org/jira/browse/MNG-5343">MNG-5343</a> for more details).</p>
<p>If you are interested the background of moving from Plexus to Guice and JSR-330, you can refer to the following articles:</p>
<ul>
@@ -133,7 +154,19 @@
</ul></div>
<div class="section">
<h2><a name="How_to_use_JSR-330"></a>How to use JSR-330</h2>
-<p>When you use JSR-330 in Maven plugins or extensions, there are two things you need to setup in your build. First you want a dependency on <tt>javax.inject</tt> so you can use the <tt>@Inject</tt>, <tt>@Named</tt>, and <tt>@Singleton</tt> annotations in your plugins and extensions. Second you need to setup the <a class="externalLink" href="https://eclipse.org/sisu/docs/api/org.eclipse.sisu.mojos/"><tt>sisu-maven-plugin</tt></a> to index the JSR-330 components you want made available to Maven. The <tt>sisu-maven-plugin</tt> creates its index in <tt>META-INF/sisu/javax.inject.Named</tt>. If you take a look in that file you will see something like the following:</p>
+<p>When you use JSR-330 in Maven plugins or extensions, there are two things you need to setup in your build:</p>
+<ol style="list-style-type: decimal">
+
+<li>
+
+<p>First you want a dependency on <tt>javax.inject</tt> so you can use the <tt>@Inject</tt>, <tt>@Named</tt>, and <tt>@Singleton</tt> annotations in your plugins and extensions.</p>
+</li>
+<li>
+
+<p>Second you need to setup the <a class="externalLink" href="https://eclipse.org/sisu/docs/api/org.eclipse.sisu.mojos/"><tt>sisu-maven-plugin</tt></a> to index the JSR-330 components you want made available to Maven. The <tt>sisu-maven-plugin</tt> creates its index in <tt>META-INF/sisu/javax.inject.Named</tt>.</p>
+</li>
+</ol>
+<p>If you take a look in that file with the example from the next paragraph, you will see something like the following:</p>
<div>
<div>
@@ -182,9 +215,9 @@ org.apache.maven.lifecycle.profiler.inte
<build>
<plugins>
<plugin>
- <groupId>org.sonatype.plugins</groupId>
+ <groupId>org.eclipse.sisu</groupId>
<artifactId>sisu-maven-plugin</artifactId>
- <version>1.1</version>
+ <version>0.3.3</version>
<executions>
<execution>
<id>generate-index</id>
@@ -367,9 +400,9 @@ public class LifecycleProfiler extends A
</executions>
</plugin>
<plugin>
- <groupId>org.sonatype.plugins</groupId>
+ <groupId>org.eclipse.sisu</groupId>
<artifactId>sisu-maven-plugin</artifactId>
- <version>1.1</version>
+ <version>0.3.3</version>
<executions>
<execution>
<id>generate-index</id>
Modified: maven/website/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.
Modified: maven/website/content/plugin-developers/cookbook/add-build-time-to-manifest.html
==============================================================================
--- maven/website/content/plugin-developers/cookbook/add-build-time-to-manifest.html (original)
+++ maven/website/content/plugin-developers/cookbook/add-build-time-to-manifest.html Sat Jul 21 16:17:24 2018
@@ -76,7 +76,8 @@
<li><a href="../../plugin-developers/cookbook/add-svn-revision-to-manifest.html" title="SVN Revision"><span class="none"></span>SVN Revision</a></li>
<li><a href="../../plugin-developers/cookbook/attach-source-javadoc-artifacts.html" title="Attach Source + Javadoc"><span class="none"></span>Attach Source + Javadoc</a></li>
<li><a href="../../plugin-developers/cookbook/generate-assembly.html" title="Assembly"><span class="none"></span>Assembly</a></li>
- <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Annotations"><span class="none"></span>Plexus Javadoc to Annotations</a></li>
+ <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Plexus Annotations"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li><a href="../../maven-jsr330.html" title="Using JSR-330"><span class="none"></span>Using JSR-330</a></li>
</ul>
</li>
<li><a href="../../developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
Modified: maven/website/content/plugin-developers/cookbook/add-svn-revision-to-manifest.html
==============================================================================
--- maven/website/content/plugin-developers/cookbook/add-svn-revision-to-manifest.html (original)
+++ maven/website/content/plugin-developers/cookbook/add-svn-revision-to-manifest.html Sat Jul 21 16:17:24 2018
@@ -77,7 +77,8 @@ Karl Heinz Marbase" />
<li class="active"><a href="#"><span class="none"></span>SVN Revision</a></li>
<li><a href="../../plugin-developers/cookbook/attach-source-javadoc-artifacts.html" title="Attach Source + Javadoc"><span class="none"></span>Attach Source + Javadoc</a></li>
<li><a href="../../plugin-developers/cookbook/generate-assembly.html" title="Assembly"><span class="none"></span>Assembly</a></li>
- <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Annotations"><span class="none"></span>Plexus Javadoc to Annotations</a></li>
+ <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Plexus Annotations"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li><a href="../../maven-jsr330.html" title="Using JSR-330"><span class="none"></span>Using JSR-330</a></li>
</ul>
</li>
<li><a href="../../developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
Modified: maven/website/content/plugin-developers/cookbook/attach-source-javadoc-artifacts.html
==============================================================================
--- maven/website/content/plugin-developers/cookbook/attach-source-javadoc-artifacts.html (original)
+++ maven/website/content/plugin-developers/cookbook/attach-source-javadoc-artifacts.html Sat Jul 21 16:17:24 2018
@@ -76,7 +76,8 @@
<li><a href="../../plugin-developers/cookbook/add-svn-revision-to-manifest.html" title="SVN Revision"><span class="none"></span>SVN Revision</a></li>
<li class="active"><a href="#"><span class="none"></span>Attach Source + Javadoc</a></li>
<li><a href="../../plugin-developers/cookbook/generate-assembly.html" title="Assembly"><span class="none"></span>Assembly</a></li>
- <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Annotations"><span class="none"></span>Plexus Javadoc to Annotations</a></li>
+ <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Plexus Annotations"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li><a href="../../maven-jsr330.html" title="Using JSR-330"><span class="none"></span>Using JSR-330</a></li>
</ul>
</li>
<li><a href="../../developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
Modified: maven/website/content/plugin-developers/cookbook/generate-assembly.html
==============================================================================
--- maven/website/content/plugin-developers/cookbook/generate-assembly.html (original)
+++ maven/website/content/plugin-developers/cookbook/generate-assembly.html Sat Jul 21 16:17:24 2018
@@ -76,7 +76,8 @@
<li><a href="../../plugin-developers/cookbook/add-svn-revision-to-manifest.html" title="SVN Revision"><span class="none"></span>SVN Revision</a></li>
<li><a href="../../plugin-developers/cookbook/attach-source-javadoc-artifacts.html" title="Attach Source + Javadoc"><span class="none"></span>Attach Source + Javadoc</a></li>
<li class="active"><a href="#"><span class="none"></span>Assembly</a></li>
- <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Annotations"><span class="none"></span>Plexus Javadoc to Annotations</a></li>
+ <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Plexus Annotations"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li><a href="../../maven-jsr330.html" title="Using JSR-330"><span class="none"></span>Using JSR-330</a></li>
</ul>
</li>
<li><a href="../../developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
Modified: maven/website/content/plugin-developers/cookbook/index.html
==============================================================================
--- maven/website/content/plugin-developers/cookbook/index.html (original)
+++ maven/website/content/plugin-developers/cookbook/index.html Sat Jul 21 16:17:24 2018
@@ -77,7 +77,8 @@ Vincent Siveton" />
<li><a href="../../plugin-developers/cookbook/add-svn-revision-to-manifest.html" title="SVN Revision"><span class="none"></span>SVN Revision</a></li>
<li><a href="../../plugin-developers/cookbook/attach-source-javadoc-artifacts.html" title="Attach Source + Javadoc"><span class="none"></span>Attach Source + Javadoc</a></li>
<li><a href="../../plugin-developers/cookbook/generate-assembly.html" title="Assembly"><span class="none"></span>Assembly</a></li>
- <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Annotations"><span class="none"></span>Plexus Javadoc to Annotations</a></li>
+ <li><a href="../../plugin-developers/cookbook/plexus-plugin-upgrade.html" title="Plexus Javadoc to Plexus Annotations"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li><a href="../../maven-jsr330.html" title="Using JSR-330"><span class="none"></span>Using JSR-330</a></li>
</ul>
</li>
<li><a href="../../developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
@@ -152,7 +153,8 @@ Vincent Siveton" />
<li><a href="./add-svn-revision-to-manifest.html">How to add SVN revision to a JAR manifest?</a></li>
<li><a href="./attach-source-javadoc-artifacts.html">How to attach source and javadoc artifacts?</a></li>
<li><a href="./generate-assembly.html">How to generate assembly?</a></li>
-<li><a href="./plexus-plugin-upgrade.html">How to upgrade from Plexus javadoc tags to Plexus Java annotations?</a></li></ul></div></div>
+<li><a href="./plexus-plugin-upgrade.html">How to upgrade from Plexus javadoc tags to Plexus Java annotations?</a></li>
+<li><a href="/maven-jsr330.html">Using JSR-330 (instead of Plexus Java annotations)</a></li></ul></div></div>
</div>
</div>
</div>
Modified: maven/website/content/plugin-developers/cookbook/plexus-plugin-upgrade.html
==============================================================================
--- maven/website/content/plugin-developers/cookbook/plexus-plugin-upgrade.html (original)
+++ maven/website/content/plugin-developers/cookbook/plexus-plugin-upgrade.html Sat Jul 21 16:17:24 2018
@@ -76,7 +76,8 @@
<li><a href="../../plugin-developers/cookbook/add-svn-revision-to-manifest.html" title="SVN Revision"><span class="none"></span>SVN Revision</a></li>
<li><a href="../../plugin-developers/cookbook/attach-source-javadoc-artifacts.html" title="Attach Source + Javadoc"><span class="none"></span>Attach Source + Javadoc</a></li>
<li><a href="../../plugin-developers/cookbook/generate-assembly.html" title="Assembly"><span class="none"></span>Assembly</a></li>
- <li class="active"><a href="#"><span class="none"></span>Plexus Javadoc to Annotations</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Plexus Javadoc to Plexus Annotations</a></li>
+ <li><a href="../../maven-jsr330.html" title="Using JSR-330"><span class="none"></span>Using JSR-330</a></li>
</ul>
</li>
<li><a href="../../developers/mojo-api-specification.html" title="Mojo API"><span class="none"></span>Mojo API</a></li>
@@ -147,7 +148,8 @@
<p>This recipe describes how to upgrade from Plexus Javadoc Tags to Plexus Java Annotations, in 2 steps:</p>
<ol style="list-style-type: decimal">
<li>replace the deprecated <a class="externalLink" href="https://codehaus-plexus.github.io/plexus-maven-plugin/"><tt>plexus-maven-plugin</tt></a>, which only supports Plexus Javadoc Tags, with its successor: <a class="externalLink" href="https://codehaus-plexus.github.io/plexus-containers/plexus-component-metadata/"><tt>plexus-component-metadata</tt></a>, which support both Plexus Javadoc Tags and Plexus Java Annotations,</li>
-<li>update sources with <a class="externalLink" href="https://codehaus-plexus.github.io/plexus-containers/plexus-component-annotations/">Java Annotations for Plexus</a>.</li></ol></div>
+<li>update sources with <a class="externalLink" href="https://codehaus-plexus.github.io/plexus-containers/plexus-component-annotations/">Java Annotations for Plexus</a>.</li></ol>
+<p><b>Notice</b>: if you're targeting components for Maven 3.1.0+, using <a href="/maven-jsr330.html">JSR-330 annotations</a> instead of Plexus Java Annotations may be a good next step</p></div>
<div class="section">
<h3><a name="Prerequisite_Plugins"></a>Prerequisite Plugins</h3>
<p>Here is the list of the plugins used:</p>
@@ -160,7 +162,7 @@
<td align="left">1.3.8</td></tr>
<tr class="a">
<td align="left"><a class="externalLink" href="https://codehaus-plexus.github.io/plexus-containers/plexus-component-metadata/"><tt>plexus-component-metadata</tt></a></td>
-<td align="left">1.5.5</td></tr></table></div>
+<td align="left">1.7.1</td></tr></table></div>
<div class="section">
<h3><a name="Equivalence_Table"></a>Equivalence Table</h3>
<table border="1" class="table table-striped">
@@ -175,7 +177,7 @@
<tr class="a">
<th align="left">latest</th>
<td align="left">1.3.8</td>
-<td align="left">1.5.5</td></tr>
+<td align="left">1.7.1</td></tr>
<tr class="b">
<th align="left">phase</th>
<td align="left">process-sources</td>
@@ -229,7 +231,7 @@
<plugin>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-component-metadata</artifactId>
- <version>1.5.5</version>
+ <version>1.7.1</version>
<executions>
<execution>
<goals>
@@ -249,7 +251,7 @@
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-component-annotations</artifactId>
- <version>1.5.5</version>
+ <version>1.7.1</version>
</dependency>
</dependencies>
</project></pre></div>