src/site/apt/usage.apt.vm

 ------
 Usage
 ------
 Denis Cabasson
 ------
 2010-01-18
 ------

~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements.  See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership.  The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License.  You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied.  See the License for the
~~ specific language governing permissions and limitations
~~ under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html

Usage

  To verify file system resources during your build, add the Verifier Plugin in
  your <<<pom.xml>>> under the <<<build>>> section. You will also need to
  create a {{{./verifications.html}<<<verifications.xml>>>}} file that contains
  the verification rules. Add the path to that file to the
  <<<verificationFile>>> configuration element.

+--------
<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-verifier-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <verificationFile>src/test/verifier/verifications-test.xml</verificationFile>
        </configuration>
        <executions>
          <execution>
            <id>main</id>
            <phase>verify</phase>
            <goals>
              <goal>verify</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
[...]
+---------

  The Verifier Plugin will fail your build if the verification rules found in
  the <<<verificationFile>>> fails. If you do not want the Verifier Plugin to
  fail your build you can set the configuration element <<<\<failOnError\>>>>
  to <<<false>>>.

  For a sample verifications file, see {{{./examples/sample-verifications.html}Sample Verifications}}.