You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jv...@apache.org on 2006/12/04 17:32:53 UTC

svn commit: r482234 - in /maven/plugins/trunk/maven-invoker-plugin/src/site: apt/index.apt apt/usage.apt fml/faq.fml

Author: jvanzyl
Date: Mon Dec  4 08:32:52 2006
New Revision: 482234

URL: http://svn.apache.org/viewvc?view=rev&rev=482234
Log:
o adding documentation for the invoker plugin

Modified:
    maven/plugins/trunk/maven-invoker-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt
    maven/plugins/trunk/maven-invoker-plugin/src/site/fml/faq.fml

Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/index.apt?view=diff&rev=482234&r1=482233&r2=482234
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/index.apt Mon Dec  4 08:32:52 2006
@@ -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

Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt?view=diff&rev=482234&r1=482233&r2=482234
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt Mon Dec  4 08:32:52 2006
@@ -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

Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/fml/faq.fml?view=diff&rev=482234&r1=482233&r2=482234
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/fml/faq.fml Mon Dec  4 08:32:52 2006
@@ -24,12 +24,11 @@
      <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>