You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/01/08 14:57:42 UTC
[maven] branch master updated: [MNG-7267] update lifecycle documentation after switch from Plexus XML
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new 8bde888 [MNG-7267] update lifecycle documentation after switch from Plexus XML
8bde888 is described below
commit 8bde888dc8d6e1f528779c72292f02ab10ac193c
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sat Jan 8 15:57:39 2022 +0100
[MNG-7267] update lifecycle documentation after switch from Plexus XML
---
.../providers/CleanLifecycleProvider.java | 2 ++
.../providers/DefaultLifecycleProvider.java | 2 ++
.../lifecycle/providers/SiteLifecycleProvider.java | 4 +++-
.../providers/WrapperLifecycleProvider.java | 2 ++
.../packaging/EarLifecycleMappingProvider.java | 2 ++
.../packaging/EjbLifecycleMappingProvider.java | 2 ++
.../packaging/JarLifecycleMappingProvider.java | 2 ++
.../MavenPluginLifecycleMappingProvider.java | 2 ++
.../packaging/PomLifecycleMappingProvider.java | 2 ++
.../packaging/RarLifecycleMappingProvider.java | 2 ++
.../packaging/WarLifecycleMappingProvider.java | 2 ++
maven-core/src/site/apt/default-bindings.apt.vm | 24 +++++++++++-----------
maven-core/src/site/apt/lifecycles.apt.vm | 20 +++++++++---------
13 files changed, 45 insertions(+), 23 deletions(-)
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/CleanLifecycleProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/CleanLifecycleProvider.java
index 93adf1d..db42df1 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/CleanLifecycleProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/CleanLifecycleProvider.java
@@ -33,6 +33,7 @@ public final class CleanLifecycleProvider
{
protected static final String LIFECYCLE_ID = "clean";
+ // START SNIPPET: clean
private static final String[] PHASES = {
"pre-clean",
"clean",
@@ -42,6 +43,7 @@ public final class CleanLifecycleProvider
private static final String[] BINDINGS = {
"clean", "org.apache.maven.plugins:maven-clean-plugin:3.1.0:clean"
};
+ // END SNIPPET: clean
@Inject
public CleanLifecycleProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/DefaultLifecycleProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/DefaultLifecycleProvider.java
index 4e55766..7eb2247 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/DefaultLifecycleProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/DefaultLifecycleProvider.java
@@ -33,6 +33,7 @@ public final class DefaultLifecycleProvider
{
protected static final String LIFECYCLE_ID = "default";
+ // START SNIPPET: default
private static final String[] PHASES = {
"validate",
"initialize",
@@ -58,6 +59,7 @@ public final class DefaultLifecycleProvider
"install",
"deploy"
};
+ // END SNIPPET: default
@Inject
public DefaultLifecycleProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/SiteLifecycleProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/SiteLifecycleProvider.java
index ca21fbf..4c6a59d 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/SiteLifecycleProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/SiteLifecycleProvider.java
@@ -33,6 +33,7 @@ public final class SiteLifecycleProvider
{
protected static final String LIFECYCLE_ID = "site";
+ // START SNIPPET: site
private static final String[] PHASES = {
"pre-site",
"site",
@@ -41,9 +42,10 @@ public final class SiteLifecycleProvider
};
private static final String[] BINDINGS = {
- "site", "org.apache.maven.plugins:maven-site-plugin:3.9.1:site",
+ "site", "org.apache.maven.plugins:maven-site-plugin:3.9.1:site",
"site-deploy", "org.apache.maven.plugins:maven-site-plugin:3.9.1:deploy"
};
+ // END SNIPPET: site
@Inject
public SiteLifecycleProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/WrapperLifecycleProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/WrapperLifecycleProvider.java
index 3eac8d1..b4a1966 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/WrapperLifecycleProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/WrapperLifecycleProvider.java
@@ -33,6 +33,7 @@ public final class WrapperLifecycleProvider
{
protected static final String LIFECYCLE_ID = "wrapper";
+ // START SNIPPET: wrapper
private static final String[] PHASES =
{
"wrapper"
@@ -41,6 +42,7 @@ public final class WrapperLifecycleProvider
private static final String[] BINDINGS = {
"wrapper", "org.apache.maven.plugins:maven-wrapper-plugin:3.1.0:wrapper"
};
+ // END SNIPPET: wrapper
@Inject
public WrapperLifecycleProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EarLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EarLifecycleMappingProvider.java
index 68cb550..336c583 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EarLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EarLifecycleMappingProvider.java
@@ -31,6 +31,7 @@ import javax.inject.Singleton;
public final class EarLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: ear
private static final String[] BINDINGS =
{
"generate-resources", "org.apache.maven.plugins:maven-ear-plugin:3.1.2:generate-application-xml",
@@ -39,6 +40,7 @@ public final class EarLifecycleMappingProvider
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: ear
@Inject
public EarLifecycleMappingProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EjbLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EjbLifecycleMappingProvider.java
index e2b8f69..4f8d414 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EjbLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/EjbLifecycleMappingProvider.java
@@ -31,6 +31,7 @@ import javax.inject.Singleton;
public final class EjbLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: ejb
private static final String[] BINDINGS =
{
"process-resources", "org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources",
@@ -42,6 +43,7 @@ public final class EjbLifecycleMappingProvider
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: ejb
@Inject
public EjbLifecycleMappingProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/JarLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/JarLifecycleMappingProvider.java
index b3811fc..207d4ad 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/JarLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/JarLifecycleMappingProvider.java
@@ -31,6 +31,7 @@ import javax.inject.Singleton;
public final class JarLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: jar
private static final String[] BINDINGS =
{
"process-resources", "org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources",
@@ -42,6 +43,7 @@ public final class JarLifecycleMappingProvider
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: jar
@Inject
public JarLifecycleMappingProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/MavenPluginLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/MavenPluginLifecycleMappingProvider.java
index 9a71ffd..520bd0a 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/MavenPluginLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/MavenPluginLifecycleMappingProvider.java
@@ -31,6 +31,7 @@ import javax.inject.Singleton;
public final class MavenPluginLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: maven-plugin
private static final String[] BINDINGS =
{
"process-resources", "org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources",
@@ -44,6 +45,7 @@ public final class MavenPluginLifecycleMappingProvider
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: maven-plugin
@Inject
public MavenPluginLifecycleMappingProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/PomLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/PomLifecycleMappingProvider.java
index 3847f7d..c6e0e8a 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/PomLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/PomLifecycleMappingProvider.java
@@ -31,11 +31,13 @@ import javax.inject.Singleton;
public final class PomLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: pom
private static final String[] BINDINGS =
{
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: pom
@Inject
public PomLifecycleMappingProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/RarLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/RarLifecycleMappingProvider.java
index 89d97e5..d77ddab 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/RarLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/RarLifecycleMappingProvider.java
@@ -31,6 +31,7 @@ import javax.inject.Singleton;
public final class RarLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: rar
private static final String[] BINDINGS =
{
"process-resources", "org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources",
@@ -42,6 +43,7 @@ public final class RarLifecycleMappingProvider
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: rar
@Inject
public RarLifecycleMappingProvider()
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/WarLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/WarLifecycleMappingProvider.java
index cd4d092..9e93531 100644
--- a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/WarLifecycleMappingProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/WarLifecycleMappingProvider.java
@@ -31,6 +31,7 @@ import javax.inject.Singleton;
public final class WarLifecycleMappingProvider
extends AbstractLifecycleMappingProvider
{
+ // START SNIPPET: war
private static final String[] BINDINGS =
{
"process-resources", "org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources",
@@ -42,6 +43,7 @@ public final class WarLifecycleMappingProvider
"install", "org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install",
"deploy", "org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1:deploy"
};
+ // END SNIPPET: war
@Inject
public WarLifecycleMappingProvider()
diff --git a/maven-core/src/site/apt/default-bindings.apt.vm b/maven-core/src/site/apt/default-bindings.apt.vm
index 50c4654..1ad708f 100644
--- a/maven-core/src/site/apt/default-bindings.apt.vm
+++ b/maven-core/src/site/apt/default-bindings.apt.vm
@@ -16,45 +16,45 @@
~~ under the License.
---
- Plugin Bindings for Default Lifecycle Reference
+ Plugins Bindings for Default Lifecycle Reference
---
Hervé Boutemy
---
2013-08-02
---
-Plugin Bindings for <<<default>>> Lifecycle Reference
+Plugins Bindings for <<<default>>> Lifecycle Reference
- The {{{./lifecycles.html}<<<default>>> lifecycle}} is defined without any plugin binding; plugin bindings are defined separately
- in <<<META-INF/plexus/default-bindings.xml>>> because they are specific for each packaging:
+ The {{{./lifecycles.html}<<<default>>> lifecycle}} is defined without any plugin binding; plugins bindings are defined separately
+ in {{{./apidocs/org/apache/maven/lifecycle/providers/packaging/package-summary.html}<<<org.apache.maven.lifecycle.providers.packaging>>>}} package
+ because they are specific for each packaging:
%{toc|fromDepth=2}
* Plugin bindings for <<<pom>>> packaging
-%{snippet|id=pom-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
+%{snippet|id=pom|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/PomLifecycleMappingProvider.java}
* Plugin bindings for <<<jar>>> packaging
-%{snippet|id=jar-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
+%{snippet|id=jar|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/JarLifecycleMappingProvider.java}
* Plugin bindings for <<<ejb>>> packaging
-%{snippet|id=ejb-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
+%{snippet|id=ejb|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/EjbLifecycleMappingProvider.java}
* Plugin bindings for <<<maven-plugin>>> packaging
-%{snippet|id=maven-plugin-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
+%{snippet|id=maven-plugin|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/MavenPluginLifecycleMappingProvider.java}
* Plugin bindings for <<<war>>> packaging
-%{snippet|id=war-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
+%{snippet|id=war|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/WarLifecycleMappingProvider.java}
* Plugin bindings for <<<ear>>> packaging
-%{snippet|id=ear-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
+%{snippet|id=ear|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/EarLifecycleMappingProvider.java}
* Plugin bindings for <<<rar>>> packaging
-%{snippet|id=rar-lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/default-bindings.xml}
-
+%{snippet|id=rar|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/packaging/RarLifecycleMappingProvider.java}
diff --git a/maven-core/src/site/apt/lifecycles.apt.vm b/maven-core/src/site/apt/lifecycles.apt.vm
index 253875f..5fa8d9e 100644
--- a/maven-core/src/site/apt/lifecycles.apt.vm
+++ b/maven-core/src/site/apt/lifecycles.apt.vm
@@ -25,31 +25,31 @@
Lifecycles Reference
- Maven defines 4 lifecycles in <<<META-INF/plexus/components.xml>>>:
+ Maven defines 4 lifecycles in {{{./apidocs/org/apache/maven/lifecycle/providers/package-summary.html}<<<org.apache.maven.lifecycle.providers>>>}} package:
%{toc|fromDepth=2}
* <<<default>>> Lifecycle
- <<<default>>> lifecycle is defined <<without>> any associated plugin.
- Plugin bindings for this lifecycle are {{{./default-bindings.html}defined separately for every packaging}}:
+ <<<default>>> lifecycle is defined only with phases, <<without>> any associated plugin binding:
+ plugins bindings for this lifecycle are {{{./default-bindings.html}defined separately for each packaging}}:
-%{snippet|id=lifecycle|file=${project.basedir}/src/main/resources/META-INF/plexus/components.xml}
+%{snippet|id=default|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/DefaultLifecycleProvider.java}
* <<<clean>>> Lifecycle
- <<<clean>>> lifecycle is defined directly with its plugin bindings.
+ <<<clean>>> lifecycle phases are defined with their plugins bindings:
-%{snippet|id=clean|file=${project.basedir}/src/main/resources/META-INF/plexus/components.xml}
+%{snippet|id=clean|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/CleanLifecycleProvider.java}
* <<<site>>> Lifecycle
- <<<site>>> lifecycle is defined directly with its plugin bindings.
+ <<<site>>> lifecycle phases are defined with their plugins bindings:
-%{snippet|id=site|file=${project.basedir}/src/main/resources/META-INF/plexus/components.xml}
+%{snippet|id=site|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/SiteLifecycleProvider.java}
* <<<wrapper>>> Lifecycle
- <<<wrapper>>> lifecycle is defined directly with its plugin bindings.
+ <<<wrapper>>> lifecycle phases are defined with their plugins bindings:
-%{snippet|id=wrapper|file=${project.basedir}/src/main/resources/META-INF/plexus/components.xml}
+%{snippet|id=wrapper|file=${project.basedir}/src/main/java/org/apache/maven/lifecycle/providers/WrapperLifecycleProvider.java}