Plugin Documentation

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

Goals

Goals available for this plugin:

Goal Description
spring-properties:compile-and-aggregate-documents Same as 'generate-and-aggregate-documents' goal, but compile child modules before. It's usable in aggregator module for 'site' phase to trigger 'generate-xml-properties-metadata' goal and 'spring-properties-processor' annotation processor to produce metadata and then document before site generation. Use the goal if compilation is not performed before, e.g. by javadoc report.
spring-properties:generate-and-aggregate-documents This goal reads all the given `META-INF/spring-configuration-metadata.json` files from the given/specified sources and it will be generating one single document that will contain all documentation created by the given sources. This goal is good for a multi module setup, it is able to read multiple files and aggregate them.
spring-properties:generate-xml-properties-metadata This goal reads all springframework xml configuration files from the given/specified directories and generate or enhance `META-INF/spring-configuration-metadata.json` that will contain all '${}' properties metadata.
spring-properties:help Display help information on spring-properties-maven-plugin.
Call mvn spring-properties:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

System Requirements

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

Maven 3.0
JDK 11

System Requirements History

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

Plugin Version Maven JDK
from 0.1 to 1.0 - 11

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>io.github.tia-ru</groupId>
          <artifactId>spring-properties-maven-plugin</artifactId>
          <version>1.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>io.github.tia-ru</groupId>
        <artifactId>spring-properties-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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