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 2017/12/20 09:35:56 UTC
[maven-invoker-plugin] 14/24: o adding documentation for the
invoker plugin
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to annotated tag maven-invoker-plugin-1.0
in repository https://gitbox.apache.org/repos/asf/maven-invoker-plugin.git
commit 59931b99ff2461d5887e941f2c8b8e409cbedf62
Author: Jason van Zyl <jv...@apache.org>
AuthorDate: Mon Dec 4 16:32:52 2006 +0000
o adding documentation for the invoker plugin
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-invoker-plugin@482234 13f79535-47bb-0310-9956-ffa450edef68
---
src/site/apt/index.apt | 16 +++--------
src/site/apt/usage.apt | 75 +++++++++++++++++++++++++++++++++++++++++++++-----
src/site/fml/faq.fml | 11 ++++----
3 files changed, 77 insertions(+), 25 deletions(-)
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index 275dfd9..bb69d6a 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -8,23 +8,15 @@
Maven 2 Invoker Plugin
- This plugin is used to transform your development life. Don't bother with self-help
- books on how to get over your build-time blues. Just use this plugin and
- everything will miraculously change.
+ The invoker Plugin is used to run a set of Maven projects and makes sure that each
+ project execution is successful, and optionally verifies the output from a given project execution.
* Goals Overview
- * {{{superduper-transform.html}superduper:transform}} performs the miraculous build transformation.
+ * {{{invoker-run.html}invoker:run}} runs a set of Maven projects that you have configured in your POM.
[]
* Usage
- Instructions on how to use the SuperDuper Plugin can be found {{{usage.html}here}}.
-
-* Examples
-
- To provide you with better understanding of some usages of the SuperDuper Plugin,
- you can take a look at the following examples:
-
- * {{{examples/sample-example.html}Sample Example}}
+ Instructions on how to use the Invoker Plugin can be found {{{usage.html}here}}.
\ No newline at end of file
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 9ebd6e8..d8c71ee 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -7,15 +7,76 @@
------
Usage
-
- This plugin is used to create miraculously transform your build!
-
-*How to miraculously transform your build
+
+* How to use the invoker plugin
- Describe here how you miraculously transform peoples' builds!
+ Below is an example of how the invoker plugin is used to test the maven-antrun-plugin. We are
+ executing a set of Maven projects and ensuring everything is all right:
-------------------
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-invoker-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <debug>true</debug>
+ <projectsDirectory>src/it</projectsDirectory>
+ <pomIncludes>
+ <pomInclude>**/pom.xml</pomInclude>
+ </pomIncludes>
+ </configuration>
+ <executions>
+ <execution>
+ <id>integration-test</id>
+ <phase>integration-test</phase>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
+-------------------
-Put your awesome example here.
+ Here is an example of how the invoker plugin is used with the maven-assembly-plugin to run a set
+ of Maven projects and then verfier they output with a Beanshell script:
--------------------
\ No newline at end of file
+-------------------
+<project>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-invoker-plugin</artifactId>
+ <configuration>
+ <debug>true</debug>
+ <projectsDirectory>src/it</projectsDirectory>
+ <pomIncludes>
+ <pomInclude>**/pom.xml</pomInclude>
+ </pomIncludes>
+ <pomExcludes>
+ <pomExclude>**/child*/pom.xml</pomExclude>
+ <pomExclude>**/module*/pom.xml</pomExclude>
+ </pomExcludes>
+ <postBuildHookScript>verify.bsh</postBuildHookScript>
+ </configuration>
+ <executions>
+ <execution>
+ <id>integration-test</id>
+ <phase>integration-test</phase>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+-------------------
+
\ No newline at end of file
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index b7c21ff..936fb32 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -24,12 +24,11 @@ under the License.
<question>Why do I need to use this plugin?</question>
<answer>
<p>
- This plugin greatly reduces the pain associated with consistent packaging concerns across
- a large set of projects, or an entire organization. Any project can specify the use of a
- remote resource bundle and have the resources incorporated into their packaging. This means
- that you can create standard settings in a parent POM somewhere in the project hierarchy and
- have all projects use package common resources in standard way like licenses, other legal
- notices and disclaimers, or anything else that may be common.
+ It is essential that you provide some form of integration testing for your projects and the Invoker Plugin
+ tries to make is easy for you to create integration tests for your Maven Plugins, new Lifecycles, or any other
+ type of Maven component that you've created. Currently the Invoker Plugin forks Maven to execute the specified
+ projects, but it is hoped that soon we will integrate the Maven Embedder into the mix to allow you run your
+ projects in process for great speed.
</p>
</answer>
</faq>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.