You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by lt...@apache.org on 2012/04/24 08:15:27 UTC
svn commit: r1329564 - in
/maven/plugins/trunk/maven-invoker-plugin/src/site/apt: ./ examples/
Author: ltheussl
Date: Tue Apr 24 06:15:26 2012
New Revision: 1329564
URL: http://svn.apache.org/viewvc?rev=1329564&view=rev
Log:
box verbatim blocks
Modified:
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/clone-projects.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/fast-use.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/filtering.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/install-artifacts.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/invoker-properties.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-conditions.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-scripts.apt.vm
maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/clone-projects.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/clone-projects.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/clone-projects.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/clone-projects.apt.vm Tue Apr 24 06:15:26 2012
@@ -34,7 +34,7 @@ Cloning Projects
<<<target/it>>>. This will allow <<<mvn clean>>> to remove the output generated
by all of the test projects.
--------------------
++------------------
<project>
...
<build>
@@ -59,7 +59,7 @@ Cloning Projects
</build>
...
</project>
--------------------
++------------------
There is another benefit of cloning the projects to a temporary location besides keeping the source tree free of build
output. When the projects are not cloned, the plugin must use temporary POMs to perform their filtering. In contrast,
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/fast-use.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/fast-use.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/fast-use.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/fast-use.apt.vm Tue Apr 24 06:15:26 2012
@@ -40,7 +40,7 @@ Fast Build Configuration
To enable this feature, you have to add a <<<settings.xml>>> file in your project (for example in <<<src/it/settings.xml>>>)
and modify the plugin configuration as this:
--------------------
++------------------
<project>
...
<build>
@@ -59,12 +59,12 @@ Fast Build Configuration
</build>
...
</project>
--------------------
++------------------
The settings must contain the following content which effectively tells Maven to use the local repository as a remote
repository:
--------------------
++------------------
<?xml version="1.0"?>
<settings>
<profiles>
@@ -100,7 +100,7 @@ Fast Build Configuration
</profile>
</profiles>
</settings>
--------------------
++------------------
The token <<<@localRepositoryUrl@>>> will be automatically replaced by the Invoker Plugin with the URL to the local
repository used for the Maven invocation.
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/filtering.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/filtering.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/filtering.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/filtering.apt.vm Tue Apr 24 06:15:26 2012
@@ -45,7 +45,7 @@ Filtering Files
The following example directory structure highlights the files which are filtered by the Invoker Plugin:
--------------------
++------------------
./
+- pom.xml
+- src/
@@ -60,11 +60,11 @@ Filtering Files
+- invoker.properties <- Filtered
+- goals.txt <- Filtered
+- profiles.txt <- Filtered
--------------------
++------------------
Below is the corresponding POM snippet for the plugin configuration:
--------------------
++------------------
<project>
<properties>
<projectPropertyUsedForFiltering>another-value</projectPropertyUsedForFiltering>
@@ -98,7 +98,7 @@ Filtering Files
</plugins>
</build>
</project>
--------------------
++------------------
When filtering the files, the plugin searches various data sources for a token's replacement value in the order
indicated below. The search terminates as soon as an existing replacement value has been found, i.e. the value
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/install-artifacts.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/install-artifacts.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/install-artifacts.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/install-artifacts.apt.vm Tue Apr 24 06:15:26 2012
@@ -34,7 +34,7 @@ Installing Artifacts
want to build your project and test the new artifacts artifact in a single step instead of
installing first and then running tests.
--------------------
++------------------
<project>
...
<build>
@@ -60,7 +60,7 @@ Installing Artifacts
</build>
...
</project>
--------------------
++------------------
\ No newline at end of file
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/invoker-properties.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/invoker-properties.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/invoker-properties.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/invoker-properties.apt.vm Tue Apr 24 06:15:26 2012
@@ -34,7 +34,7 @@ Invoker Properties
control the build settings on a per project basis. The exact name of this properties file is configurable but it needs
to reside in the base directory of the respective project as shown below:
--------------------
++------------------
./
+- src/
+- it/
@@ -42,7 +42,7 @@ Invoker Properties
+- pom.xml
+- invoker.properties
+- src/
--------------------
++------------------
There are only a few keys supported in this file and their names typically match the corresponding parameters in the
plugin configuration. For a complete overview of supported properties, see the example given in the documentation of
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/post-build-script.apt.vm Tue Apr 24 06:15:26 2012
@@ -32,7 +32,7 @@ Using a Post-Build Script
with a {{{http://www.beanshell.org/}BeanShell}} or {{{http://groovy.codehaus.org/}Groovy}} script. The name of the
script file in this case is <<<verify.bsh>>>.
--------------------
++------------------
<project>
<build>
<plugins>
@@ -57,7 +57,7 @@ Using a Post-Build Script
</plugins>
</build>
</project>
--------------------
++------------------
Below is an example post-build BeanShell script (<<<verify.bsh>>>) that checks for the existence of a JAR file after
the build has run. If the JAR file does not exist, the script throws an exception which causes the Invoker Plugin to
@@ -65,7 +65,7 @@ Using a Post-Build Script
as a failure condition. And of course, if the script exists abnormally due to an exception, the plugin will flag the
corresponding build as a failure, too.
--------------------
++------------------
import java.io.*;
File file = new File( basedir, "target/my-test-project-1.0-SNAPSHOT.jar" );
@@ -73,7 +73,7 @@ if ( !file.isFile() )
{
throw new FileNotFoundException( "Could not find generated JAR: " + file );
}
--------------------
++------------------
Complementary to the post-build hook script, you can also create a pre-build hook script that will be run before
the invocation of Maven. This can be used to do some preparations for the build.
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-conditions.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-conditions.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-conditions.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-conditions.apt.vm Tue Apr 24 06:15:26 2012
@@ -31,21 +31,21 @@ Selector Conditions
Starting with plugin version 1.4, some keys of the {{{./invoker-properties.html}Invoker Properties}} can be used to
skip individual projects based on the current JRE version or OS family as illustrated in the example below:
--------------------
++------------------
# build project if JRE version is 1.4 or higher, but exclude version 1.4.1
invoker.java.version = 1.4+, !1.4.1
# build project if OS family is not Windows
invoker.os.family = !windows
--------------------
++------------------
In addition, with plugin version 1.5, there is the ability to skip individual projects based on the current Maven
version as illustrated in the example below:
--------------------
++------------------
# build project if Maven version is 2.0.10 or higher, but exclude versions 2.1.0 and 2.2.0
invoker.maven.version = 2.0.10+, !2.1.0, !2.2.0
--------------------
++------------------
The values of these keys are comma separated tokens. A token prefixed with "!" denotes an exclusion, otherwise it
denotes an inclusion. A project is build if no exclusion matches and if no inclusions are given or at least one of
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-scripts.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-scripts.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-scripts.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/examples/selector-scripts.apt.vm Tue Apr 24 06:15:26 2012
@@ -32,7 +32,7 @@ Selector Scripts
whatever critria are expressed in the script as illustrated in the following example. Assume the
following directory structure:
--------------------
++------------------
./
+- pom.xml
+- src/
@@ -42,11 +42,11 @@ Selector Scripts
+- pom.xml
+- check-assumptions.bsh
+- src/
--------------------
++------------------
The plugin configuration for this example would look like this:
--------------------
++------------------
<project>
...
<build>
@@ -78,7 +78,7 @@ Selector Scripts
</build>
...
</project>
--------------------
++------------------
If the check-assumptions.bsh script returns <<<true>>> or does not return a value, then the project will be executed.
Modified: maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm?rev=1329564&r1=1329563&r2=1329564&view=diff
==============================================================================
--- maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-invoker-plugin/src/site/apt/usage.apt.vm Tue Apr 24 06:15:26 2012
@@ -39,7 +39,7 @@ Usage
The following example demonstrates a basic plugin configuration for running integration tests. Let's assume the following
directory structure of your project:
--------------------
++------------------
./
+- pom.xml
+- src/
@@ -54,13 +54,13 @@ Usage
+- test.properties
+- verify.bsh
+- src/
--------------------
++------------------
In this example, the directory <<<src/it>>> is the location where all the IT projects reside. You simply put each
integration test into a distinct sub directory, like shown by <<<first-it>>> and <<<second-it>>>. The plugin
configuration for this example would look like this:
--------------------
++------------------
<project>
...
<build>
@@ -92,13 +92,13 @@ Usage
</build>
...
</project>
--------------------
++------------------
Now, to get things going, just tell Maven to execute the lifecycle phase <<<integration-test>>>:
--------------------
++------------------
mvn integration-test
--------------------
++------------------
First, the <<<invoker:install>>> goal will be executed during the phase <<<pre-integration-test>>> and will copy the
main artifact of the project along with any attached artifacts over to <<<target/local-repo>>>. Furthermore, any