Apache Maven Invoker Plugin – Plugin Documentation

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Report?	Description
invoker:help	No	Display help information on maven-invoker-plugin. Call `mvn invoker:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
invoker:install	No	Installs the project artifacts of the main build into the local repository as a preparation to run the sub projects. More precisely, all artifacts of the project itself, all its locally reachable parent POMs and all its dependencies from the reactor will be installed to the local repository.
invoker:integration-test	No	Searches for integration test Maven projects, and executes each, collecting a log in the project directory, will never fail the build, designed to be used in conjunction with the verify mojo.
invoker:report	Yes	Generate a report based on the results of the Maven invocations. Note: This mojo doesn't fork any lifecycle, if you have a clean working copy, you have to use a command like `mvn clean integration-test site` to ensure the build results are present when this goal is invoked.
invoker:run	No	Searches for integration test Maven projects, and executes each, collecting a log in the project directory, and outputting the results to the command line.
invoker:verify	No	Checks the results of maven-invoker-plugin based integration tests and fails the build if any tests failed.

System Requirements

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

Maven	3.6.3
JDK	1.8

System Requirements History

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

Plugin Version	Maven	JDK
from 3.7.0 to 3.8.1	3.6.3	8
from 3.3.0 to 3.6.1	3.2.5	8
3.2.2	3.1.1	7
from 3.1.0 to 3.2.1	3.0	7
from 3.0.0 to 3.0.1	3.0	6
2.0.0	2.2.1	6
from 1.8 to 1.10	2.2.1	5
from 1.6 to 1.7	2.0.6	5
from 1.1 to 1.5	2.0.6	1.4
1.0	2.0	-

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>org.apache.maven.plugins</groupId>
          <artifactId>maven-invoker-plugin</artifactId>
          <version>3.8.1</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-invoker-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-invoker-plugin</artifactId>
        <version>3.8.1</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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