Plugin Documentation

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

Goals

Goals available for this plugin:

Goal	Report?	Description
changes:announcement-generate	No	Goal which generates an announcement from the announcement template.
changes:announcement-mail	No	Goal which sends an announcement through email.
changes:changes	Yes	Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.
changes:changes-check	No	Goal which checks that the changes.xml file has the necessary data to generate an announcement or a report for the current release.
changes:changes-report	Yes	Deprecated. use `change` goal Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.
changes:changes-validate	No	Goal which validate the `changes.xml` file.
changes:github-changes	Yes	Goal which downloads issues from GitHub and generates a report.
changes:github-report	Yes	Deprecated. use `github-changes` goal Goal which downloads issues from GitHub and generates a report.
changes:help	No	Display help information on maven-changes-plugin. Call `mvn changes:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
changes:jira-changes	Yes	Goal which downloads issues from the Issue Tracking System and generates a report.
changes:jira-report	Yes	Deprecated. use `jira-changes` goal Goal which downloads issues from the Issue Tracking System and generates a report.
changes:trac-changes	Yes	Deprecated. prepared for removal in next major version due to lack of maintainers Goal which downloads issues from the Issue Tracking System and generates a report.
changes:trac-report	Yes	Deprecated. use `track-changes` goal Goal which downloads issues from the Issue Tracking System and generates a report.

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.0.0-M1	3.6.3	8
from 2.12 to 2.12.1	2.2.1	6
from 2.5 to 2.11	2.2.1	5
from 2.0 to 2.4	2.0.6	1.4
2.0-beta-3	2.0.6	-

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-changes-plugin</artifactId>
          <version>3.0.0-M1</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-changes-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-changes-plugin</artifactId>
        <version>3.0.0-M1</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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