changelog:dev-activity

Note:

This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-changelog-plugin:3.0.0-M1:dev-activity

Description:

Generate a developer activity report.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Required Parameters

Name Type Since Description
<basedir> File - Input dir. Directory where the files under SCM control are located.
User Property: basedir
<connectionType> String - Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection".
Default: connection
<dateFormat> String - Used to specify the date format of the log entries that are retrieved from your SCM system.
Default: yyyy-MM-dd HH:mm:ss
User Property: changelog.dateFormat
<issueIDRegexPattern> String 2.2 A pattern used to identify 'issue tracker' IDs such as those used by JIRA, Bugzilla and alike in the SCM commit messages. Any matched patterns are replaced with issueLinkUrl URL. The default value is a JIRA-style issue identification pattern.

Note: Default value is [a-zA-Z]{2,}-\d+

Default: [a-zA-Z]{2,}-\d+
User Property: issueIDRegexPattern
<issueLinkUrl> String 2.2 The issue tracker URL used when replacing any matched issueIDRegexPattern found in the SCM commit messages. The default is URL is the codehaus JIRA URL. If %ISSUE% is found in the URL it is replaced with the matched issue ID, otherwise the matched issue ID is appended to the URL.
Default: https://issues.apache.org/jira/browse/%ISSUE%
User Property: issueLinkUrl
<outputXML> File - Output file for xml document
Default: ${project.build.directory}/changelog.xml
<outputXMLExpiration> int - Allows the user to make changelog regenerate the changelog.xml file for the specified time in minutes.
Default: 60
User Property: outputXMLExpiration
<type> String - Used to specify whether to build the log using range, tag or date.
Default: range
User Property: changelog.type

Optional Parameters

Name Type Since Description
<dates> List<String> - Used to specify the absolute date (or list of dates) to start log entries from.
<developers> List<Developer> 2.2 List of developers to be shown on the report.
User Property: project.developers
<displayChangeSetDetailUrl> String 2.2

A template string that is used to create the changeset URL. If not defined no change set link will be created.

There is one special token that you can use in your template:
  • %REV% - this is the changeset revision

Example: http://fisheye.sourceforge.net/changelog/a-project/?cs=%REV%

Note: If you don't supply the %REV% token in your template, the revision will simply be appended to your template URL.


User Property: displayChangeSetDetailUrl
<displayFileDetailUrl> String - A template string that is used to create the URL to the file details. There is a special token that you can use in your template:
  • %FILE% - this is the path to a file

Example: http://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup

Note: If you don't supply the token in your template, the path of the file will simply be appended to your template URL.


Default: ${project.scm.url}
User Property: displayFileDetailUrl
<displayFileRevDetailUrl> String 2.2

A template string that is used to create the revision aware URL to the file details in a similar fashion to the displayFileDetailUrl. When a report contains both file and file revision information, as in the Change Log report, this template string can be used to create a revision aware URL to the file details.

If not defined this template string defaults to the same value as the displayFileDetailUrl and thus revision number aware links will not be used.

There are two special tokens that you can use in your template:
  • %FILE% - this is the path to a file
  • %REV% - this is the revision of the file

Example: http://fisheye.sourceforge.net/browse/a-project/%FILE%?r=%REV%

Note: If you don't supply the %FILE% token in your template, the path of the file will simply be appended to your template URL.


User Property: displayFileRevDetailUrl
<encodeFileUri> boolean 2.3 Encodes slashes in file uri. Required for some repository browsers like gitblit
Default: false
User Property: encodeFileUri
<excludes> String[] 2.3 List of files to include. Specified as fileset patterns of files to omit in the report
<headingDateFormat> String 2.1 Used to specify the format to use for the dates in the headings of the report.
Default: yyyy-MM-dd
User Property: changelog.headingDateFormat
<includes> String[] 2.3 List of files to include. Specified as fileset patterns of files to include in the report
<omitFileAndRevision> boolean - If true, file and revision information is omitted for each SCM entry.
Default: false
User Property: omitFileAndRevision
<outputEncoding> String - The file encoding when writing non-HTML reports.
Default: ${project.reporting.outputEncoding}
User Property: changelog.outputEncoding
<passphrase> String - The passphrase (used by java svn).
User Property: passphrase
<password> String - The user password (used by svn and starteam protocol).
User Property: password
<privateKey> String - The private key (used by java svn).
User Property: privateKey
<providerImplementations> Map<String,String> - List of provider implementations.
<range> int - Used to specify the number of days of log entries to retrieve.
Default: -1
User Property: changelog.range
<scmUrl> String - The URL to view the scm. Basis for external links from the generated report.
User Property: project.scm.url
<skip> boolean 2.3 Skip the Changelog report generation. Most useful on the command line via "-Dchangelog.skip=true".
Default: false
User Property: changelog.skip
<systemProperties> Properties - The system properties to use (needed by the perforce scm provider).
<tagBase> String - The url of tags base directory (used by svn protocol).
User Property: tagBase
<tags> List<String> - Used to specify the tag (or list of tags) to start log entries from.
<username> String - The user name (used by svn and starteam protocol).
User Property: username

Parameter Details

<basedir>

Input dir. Directory where the files under SCM control are located.
  • Type: java.io.File
  • Required: Yes
  • User Property: basedir

<connectionType>

Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection".
  • Type: java.lang.String
  • Required: Yes
  • Default: connection

<dateFormat>

Used to specify the date format of the log entries that are retrieved from your SCM system.
  • Type: java.lang.String
  • Required: Yes
  • User Property: changelog.dateFormat
  • Default: yyyy-MM-dd HH:mm:ss

<dates>

Used to specify the absolute date (or list of dates) to start log entries from.
  • Type: java.util.List<java.lang.String>
  • Required: No

<developers>

List of developers to be shown on the report.
  • Type: java.util.List<org.apache.maven.model.Developer>
  • Since: 2.2
  • Required: No
  • User Property: project.developers

<displayChangeSetDetailUrl>

A template string that is used to create the changeset URL. If not defined no change set link will be created.

There is one special token that you can use in your template:
  • %REV% - this is the changeset revision

Example: http://fisheye.sourceforge.net/changelog/a-project/?cs=%REV%

Note: If you don't supply the %REV% token in your template, the revision will simply be appended to your template URL.

  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • User Property: displayChangeSetDetailUrl

<displayFileDetailUrl>

A template string that is used to create the URL to the file details. There is a special token that you can use in your template:
  • %FILE% - this is the path to a file

Example: http://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup

Note: If you don't supply the token in your template, the path of the file will simply be appended to your template URL.

  • Type: java.lang.String
  • Required: No
  • User Property: displayFileDetailUrl
  • Default: ${project.scm.url}

<displayFileRevDetailUrl>

A template string that is used to create the revision aware URL to the file details in a similar fashion to the displayFileDetailUrl. When a report contains both file and file revision information, as in the Change Log report, this template string can be used to create a revision aware URL to the file details.

If not defined this template string defaults to the same value as the displayFileDetailUrl and thus revision number aware links will not be used.

There are two special tokens that you can use in your template:
  • %FILE% - this is the path to a file
  • %REV% - this is the revision of the file

Example: http://fisheye.sourceforge.net/browse/a-project/%FILE%?r=%REV%

Note: If you don't supply the %FILE% token in your template, the path of the file will simply be appended to your template URL.

  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • User Property: displayFileRevDetailUrl

<encodeFileUri>

Encodes slashes in file uri. Required for some repository browsers like gitblit
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: encodeFileUri
  • Default: false

<excludes>

List of files to include. Specified as fileset patterns of files to omit in the report
  • Type: java.lang.String[]
  • Since: 2.3
  • Required: No

<headingDateFormat>

Used to specify the format to use for the dates in the headings of the report.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: changelog.headingDateFormat
  • Default: yyyy-MM-dd

<includes>

List of files to include. Specified as fileset patterns of files to include in the report
  • Type: java.lang.String[]
  • Since: 2.3
  • Required: No

<issueIDRegexPattern>

A pattern used to identify 'issue tracker' IDs such as those used by JIRA, Bugzilla and alike in the SCM commit messages. Any matched patterns are replaced with issueLinkUrl URL. The default value is a JIRA-style issue identification pattern.

Note: Default value is [a-zA-Z]{2,}-\d+
  • Type: java.lang.String
  • Since: 2.2
  • Required: Yes
  • User Property: issueIDRegexPattern
  • Default: [a-zA-Z]{2,}-\d+

<issueLinkUrl>

The issue tracker URL used when replacing any matched issueIDRegexPattern found in the SCM commit messages. The default is URL is the codehaus JIRA URL. If %ISSUE% is found in the URL it is replaced with the matched issue ID, otherwise the matched issue ID is appended to the URL.
  • Type: java.lang.String
  • Since: 2.2
  • Required: Yes
  • User Property: issueLinkUrl
  • Default: https://issues.apache.org/jira/browse/%ISSUE%

<omitFileAndRevision>

If true, file and revision information is omitted for each SCM entry.
  • Type: boolean
  • Required: No
  • User Property: omitFileAndRevision
  • Default: false

<outputEncoding>

The file encoding when writing non-HTML reports.
  • Type: java.lang.String
  • Required: No
  • User Property: changelog.outputEncoding
  • Default: ${project.reporting.outputEncoding}

<outputXML>

Output file for xml document
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/changelog.xml

<outputXMLExpiration>

Allows the user to make changelog regenerate the changelog.xml file for the specified time in minutes.
  • Type: int
  • Required: Yes
  • User Property: outputXMLExpiration
  • Default: 60

<passphrase>

The passphrase (used by java svn).
  • Type: java.lang.String
  • Required: No
  • User Property: passphrase

<password>

The user password (used by svn and starteam protocol).
  • Type: java.lang.String
  • Required: No
  • User Property: password

<privateKey>

The private key (used by java svn).
  • Type: java.lang.String
  • Required: No
  • User Property: privateKey

<providerImplementations>

List of provider implementations.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<range>

Used to specify the number of days of log entries to retrieve.
  • Type: int
  • Required: No
  • User Property: changelog.range
  • Default: -1

<scmUrl>

The URL to view the scm. Basis for external links from the generated report.
  • Type: java.lang.String
  • Required: No
  • User Property: project.scm.url

<skip>

Skip the Changelog report generation. Most useful on the command line via "-Dchangelog.skip=true".
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: changelog.skip
  • Default: false

<systemProperties>

The system properties to use (needed by the perforce scm provider).
  • Type: java.util.Properties
  • Required: No

<tagBase>

The url of tags base directory (used by svn protocol).
  • Type: java.lang.String
  • Required: No
  • User Property: tagBase

<tags>

Used to specify the tag (or list of tags) to start log entries from.
  • Type: java.util.List<java.lang.String>
  • Required: No

<type>

Used to specify whether to build the log using range, tag or date.
  • Type: java.lang.String
  • Required: Yes
  • User Property: changelog.type
  • Default: range

<username>

The user name (used by svn and starteam protocol).
  • Type: java.lang.String
  • Required: No
  • User Property: username