Plugin Documentation

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

Goals

Goals available for this plugin:

Goal	Description
build-helper:fix-site-anchors	Fixes anchors in URLs in site files. If a Markdown file contains a link to a method's Javadoc, in modern Java versions this link contains `(` and `)`. Even if these are escaped, the site plugin replaces these with `.28` and `.29` respectively. This mojo can be used to fix these incorrect replacements.
build-helper:help	Display help information on build-helper-maven-plugin. Call `mvn build-helper:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
build-helper:jar-license	Add a license file to created JAR files and, if applicable, source JAR files. License files are first resolved relative to the current directory. If it cannot be found there, parent directories are checked until one of the following occurs: The parent directory is not part of the Maven project (does not contain a `pom.xml` file), and is not the root directory of the current Git project. The maximum number of parent directories has been reached.
build-helper:javadoc-license	Add a license file to created Javadoc JAR files. License files are first resolved relative to the current directory. If it cannot be found there, parent directories are checked until one of the following occurs: The parent directory is not part of the Maven project (does not contain a `pom.xml` file), and is not the root directory of the current Git project. The maximum number of parent directories has been reached.
build-helper:join-paths	Join paths using the platform-specific path separator and provide the result as a Maven property. While paths for most of the standard Maven plugins can be defined in a way that is platform agnostic, sometimes it's necessary to add flags directly. For instance, when configuring Javadoc's `--snippet-path` flag, the value should use the platform-specific path separator.
build-helper:site-index	Generate a Markdown site index based on another Markdown file. This goal will provide the following transformations: Add an HTML title. Make any link that starts with the project's URL relative to that URL. Remove any badges that match any of a set of provided patterns. Badges will be removed if: They are preceded by a space. In this case, the leading space is removed as well. They are on a line of their own. In this case, the entire line is removed.

System Requirements

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

Maven	3.9.5
JDK	11

System Requirements History

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

Plugin Version	Maven	JDK
2.0	-	11
from 1.0 to 1.2.1	-	8

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>com.github.robtimus</groupId>
          <artifactId>build-helper-maven-plugin</artifactId>
          <version>2.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.github.robtimus</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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