Commons Build Plugin – Plugin Documentation

Plugin Documentation

Goals available for this plugin:

Goal	Description
commons-build:all	Apache Commons Build Mojo: Generate all pages.
commons-build:all-sandbox	Apache Commons Build Mojo: Generate all sandbox pages.
commons-build:contributing-md	Apache Commons Build Mojo: Generate CONTRIBUTING.md.
commons-build:copy-javadoc-files	Commons Build: Copy NOTICE and LICENSE files to -javadoc.jar
commons-build:download-page	Apache Commons Build Mojo: Generate Download page.
commons-build:jira-page	Apache Commons Build Mojo: Generate Issue Tracking page.
commons-build:mail-page	Apache Commons Build Mojo: Generate Mailing List page.
commons-build:notice-txt	Apache Commons Build Mojo: Generate NOTICE.txt.
commons-build:readme-md	Apache Commons Build Mojo: Generate README.md.
commons-build:sandbox-jira-page	Apache Commons Build Mojo: Generate Sandbox Issue Tracking page.

System Requirements

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

Maven	3.9.6
JDK	17

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

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