Plugin Documentation

Goals available for this plugin:

Goal Description
oakpal:help Display help information on oakpal-maven-plugin.
Call mvn oakpal:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
oakpal:opear-package Bundles up project dependencies an exported plans as an opear (OakPAL Encapsulated Archive) file, and attaches it to the project.
oakpal:opear-plan Exports a plan builder configuration for inclusion in an opear file, using the OpearPackageMojo.
oakpal:scan Scans the main project artifact by simulating package installation and listening for violations reported by the configured checks.
oakpal:scan-many Scans a list of artifacts by simulating package installation and listening for violations reported by the configured checks. This goal supports the use of ProgressChecks that must evaluate the side effects of installing packages in combination, such as for detection of workspace filter overlap. More simply, this goal can be used in a sidecar project to scan multiple artifacts produced by previous builds using a common library of checklists.
oakpal:verify Deferred reporting and reacting to oakpal check reports during the verify phase.
oakpal:webster Execute Webster targets that read from an external Oak JCR repository to update nodetypes, privileges, and checklist files managed in a maven project.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.2.5
JDK 1.8
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>net.adamcin.oakpal</groupId>
          <artifactId>oakpal-maven-plugin</artifactId>
          <version>2.2.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>net.adamcin.oakpal</groupId>
        <artifactId>oakpal-maven-plugin</artifactId>
        <version>2.2.2</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"