Usage

This plugin sends svn commands to list all existing tags, then parses the logs for each of them and publishes the resulting report.
It uses the scm configuration from the pom.xml to access the scm repository, so this must be set.
It is a reporting plugin and as such should be declared in the reporting section of the pom.xml

Goals

There is just one simple goal for this report: report.
You should not have to call it specifically.

Pre-requisite

There are some requisite for using this plugin:

  • As this plugin uses the SCM commands, it is necessary to have the svn or hg command line executable in your path.
  • This plugins needs Java 1.4 or more to run correctly.

Basic Example

Here we have a basic configuration example. We suppose that the <issueManagement> and <scm> elements are configured

 <reporting>
   <plugins>
     <plugin>
       <groupId>org.codehaus.mojo</groupId>
       <artifactId>scmchangelog-maven-plugin</artifactId>
       <version>1.3</version>
     </plugin>
         ...
    </plugins>
 </reporting>

Advanced Configuration

Here we have configured the plugin overriding the <issueManagement> and <scm> elements.
We have specified:

  • trackerUrlPattern: this allows you to specify a pattern to link an issue to any tracker.
  • trackerType: this allows you to specify the issue tracker used.
    Currently it supports three trackers:
    • sourceforge
    • jira
    • xplanner
    • bugzilla
  • grammar: this allows you to specify the grammar used to parse the svn logs.
    Currently it supports four grammars:
    • "MANU" which uses @operation:issue;comments
    • "REMY" which uses [operation:issue]comments
    • "BUGZILLA" which uses bug issue: comments
    • "ALL" which uses comments
  • connectionUrl: the same as the <connectionUrl> element in the<scm> element.
  • tagBase: the url to the tags directory.
  • filter: a regexp used to filter tags by their name. Only tags matching the specified regexp are used to produce the report
  • releasesOrder: to order releases historically or alphabetically.

 <reporting>
   <plugins>
     <plugin>
       <groupId>org.codehaus.mojo</groupId>
       <artifactId>scmchangelog-maven-plugin</artifactId>
       <version>1.3</version>
       <configuration>
         <trackerUrlPattern>http://sourceforge.net/tracker/?atid=637380&group_id=104240&func=browse</trackerUrlPattern>
         <trackerType>sourceforge</trackerType>
         <grammar>REMY</grammar>
         <connectionUrl>scm:svn:https://retroweaver.svn.sourceforge.net/svnroot/retroweaver/trunk</connectionUrl>
         <tagBase>https://retroweaver.svn.sourceforge.net/svnroot/retroweaver/tags/</tagBase>
         <filter>.*</filter>
       </configuration>
     </plugin>
   </plugins>
 </reporting>