Plugin Documentation

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

Goals

Goals available for this plugin:

Goal Description
toolchains:display-discovered-jdk-toolchains Discover the JDK toolchains and print them to the console.
toolchains:generate-jdk-toolchains-xml Run the JDK toolchain discovery mechanism and generates a toolchains XML.
toolchains:help Display help information on maven-toolchains-plugin.
Call mvn toolchains:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
toolchains:select-jdk-toolchain Discover JDK toolchains and select a matching one.
toolchains:toolchain Check that toolchains requirements are met by currently configured toolchains in toolchains.xml and store the selected toolchain in build context for later retrieval by other plugins.

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
3.2.0 3.6.3 8
3.1.0 3.2.5 8
3.0.0 3.0 7
1.1 2.2.1 5
1.0 2.0.9 1.4

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-toolchains-plugin</artifactId>
          <version>3.2.0</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-toolchains-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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