Apache Maven Changelog Plugin

The Maven Changelog Plugin generates reports regarding the recent changes in your Software Configuration Management or SCM. These reports include the changelog report, developer activity report and the file activity report.

Goals Overview

The Changelog Plugin has three goals:

  • changelog:changelog generates the changelog report. The changelog report shows all the SCM activities including the dates, files, and author of the revisions that occurred during the specified change set.
  • changelog:dev-activity generates the developer activity report. The dev-activity report shows a summary of the total commits, and the number of files changed of each developer listed in the project descriptor.
  • changelog:file-activity generates the file activity report. The file-activity report lists all files that were revised during the specified change set. It is arranged in a way where the file with the most number of revisions is listed first.

Usage

General instructions on how to use the Changelog Plugin can be found on the usage page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's wiki page.

In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Examples

The following examples show how to use the Changelog Plugin in more advanced use-cases: