Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-changelog-plugin:2.3:changelog
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| basedir | File | - | Input dir. Directory where the files under SCM control are located. User property is: 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 value is: connection. |
| dateFormat | String | - | Used to specify the date format of the log entries that are
retrieved from your SCM system. Default value is: yyyy-MM-dd HH:mm:ss. User property is: 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 value is: [a-zA-Z]{2,}-\d+. User property is: 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 value is: http://jira.codehaus.org/browse/%ISSUE%. User property is: issueLinkUrl. |
| outputXML | File | - | Output file for xml document Default value is: ${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 value is: 60. User property is: outputXMLExpiration. |
| type | String | - | Used to specify whether to build the log using range, tag or date. Default value is: range. User property is: changelog.type. |
| Name | Type | Since | Description |
|---|---|---|---|
| commentFormat | String | - | Comment format string used for interrogating the revision control
system. Currently only used by the ClearcaseChangeLogGenerator. User property is: changelog.commentFormat. |
| dates | List | - | Used to specify the absolute date (or list of dates) to start log
entries from. |
| developers | List | 2.2 | List of developers to be shown on the report. User property is: 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:
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 is: 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:
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 value is: ${project.scm.url}. User property is: 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:
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 is: displayFileRevDetailUrl. |
| encodeFileUri | boolean | 2.3 | Encodes slashes in file uri. Required for some repository browsers
like gitblit Default value is: false. User property is: 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 value is: yyyy-MM-dd. User property is: changelog.headingDateFormat. |
| includes | String[] | 2.3 | List of files to include. Specified as fileset patterns of files to
include in the report |
| outputEncoding | String | - | The file encoding when writing non-HTML reports. Default value is: ${project.reporting.outputEncoding}. User property is: changelog.outputEncoding. |
| passphrase | String | - | The passphrase (used by java svn). User property is: passphrase. |
| password | String | - | The user password (used by svn and starteam protocol). User property is: password. |
| privateKey | String | - | The private key (used by java svn). User property is: privateKey. |
| providerImplementations | Map | - | List of provider implementations. |
| range | int | - | Used to specify the number of days of log entries to retrieve. Default value is: -1. User property is: changelog.range. |
| scmUrl | String | - | The URL to view the scm. Basis for external links from the
generated report. User property is: project.scm.url. |
| skip | boolean | 2.3 | Skip the Changelog report generation. Most useful on the command
line via "-Dchangelog.skip=true". Default value is: false. User property is: 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 is: tagBase. |
| tags | List | - | 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 is: username. |
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.
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.
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.
skip:
tags:
type: