Fork me on GitHub

gitlog:report

Note:This goal should be used as a Maven report.

Full name:

com.github.danielflower.mavenplugins:gitlog-maven-plugin:1.14.0:report

Description:

Goal which generates a changelog based on commits made to the current git repo.

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
asciidocChangeLogFilename String - The filename of the Asciidoc changelog, if generated.
Default value is: changelog.adoc.
asciidocHeading String - asciidoc title level
Default value is: =.
asciidocHeadingReleaseNotes String - asciidoc title level
Default value is: =.
asciidocReleaseNotesFilename String - The filename of the Asciidoc changelog, if generated.
Default value is: releaseNotes.adoc.
asciidocTableView boolean - If true, the changelog will be in an asciidoc table
Default value is: false.
asciidocTableViewHeader1 String - asciidoc table header 1
Default value is: Date.
asciidocTableViewHeader1ReleaseNotes String - asciidoc table header 1
Default value is: Date.
asciidocTableViewHeader2 String - asciidoc table header 2
Default value is: Commit.
asciidocTableViewHeader2ReleaseNotes String - asciidoc table header 2
Default value is: Merge.
asciidocTableViewReleaseNotes boolean - If true, the changelog will be in an asciidoc table
Default value is: false.
bugzillaPattern String - Regexp pattern to extract the number from the message.

The default is: "Bug (\\d+)". Group 1 (the number) is used in links, so "?:" must be used any non relevant group, ex.: (?:Bug|UPDATE|FIX|ADD|NEW|#) ?#?(\d+)


Default value is: Bug (\d+).
dateFormat String - Used to set date format in log messages.
Default value is: yyyy-MM-dd HH:mm:ss Z.
excludeCommiters List - Exclude in the changelog all commits by a given commiter
excludeCommitsPattern String - Regexp pattern to filter out commits (using Matcher.matches())
fullGitMessage boolean - (no description)
Default value is: false.
fullGitMessageReleaseNotes boolean - (no description)
Default value is: false.
generatAsciidocChangeLog boolean - (no description)
Default value is: false.
generatAsciidocReleaseNotes boolean - (no description)
Default value is: false.
generateAsciidocChangeLog boolean - If true, then an Asciidoc changelog will be generated.
Default value is: false.
generateAsciidocReleaseNotes boolean - If true, then an Asciidoc changelog will be generated.
Default value is: false.
generateHTMLTableOnlyChangeLog boolean - If true, then an HTML changelog which contains only a table element will be generated. This incomplete HTML page is suitable for inclusion in other webpages, for example you may want to embed it in a wiki page.
Default value is: false.
generateJSONChangeLog boolean - If true, then a JSON changelog will be generated.
Default value is: true.
generateMarkdownChangeLog boolean - If true, then a markdown changelog will be generated.
Default value is: false.
generatePlainTextChangeLog boolean - If true, then a plain text changelog will be generated.
Default value is: true.
generateSimpleHTMLChangeLog boolean - If true, then a simple HTML changelog will be generated.
Default value is: true.
htmlTableOnlyChangeLogFilename String - The filename of the HTML table changelog, if generated.
Default value is: changelogtable.html.
includeCommitsAfter Date - Include in the changelog the commits after this parameter value.
Default value is: 1970-01-01 00:00:00.0 AM.
includeCommitsAfterCommit String - Include in the changelog the commits after the commit id of this parameter value.
includeCommitsDuringTheLastDays Integer - Include in the changelog the commits which are newer than the given amount of days.
issueManagementSystem String - Used to create links to your issue tracking system for HTML reports. If unspecified, it will try to use the value specified in the issueManagement section of your project's POM. The following values are supported: a value containing the string "github" for the GitHub Issue tracking software; a value containing the string "jira" for Jira tracking software. Any other value will result in no links being made.
User property is: project.issueManagement.system.
issueManagementUrl String - Used to create links to your issue tracking system for HTML reports. If unspecified, it will try to use the value specified in the issueManagement section of your project's POM.
User property is: project.issueManagement.url.
jiraPattern String - Regexp pattern to extract the number from the message.

The default is: "[A-Z]+-[0-9]+". Group 1 (the number) is used in links, so "?:" must be used any non relevant group,


Default value is: [A-Z]+-[0-9]+.
jsonChangeLogFilename String - The filename of the JSON changelog, if generated.
Default value is: changelog.json.
markdownChangeLogAppend boolean - Append info to existing markdown file (Default: false)
Default value is: false.
markdownChangeLogFilename String - The filename of the markdown changelog, if generated.
Default value is: changelog.md.
mergeCommitFilter boolean - If true, the merge commit filter will be configured.
Default value is: true.
mergeCommitFilterReleaseNotes boolean - If true, the merge commit filter will be configured.
Default value is: true.
outputDirectory File - The directory to put the reports in. Defaults to the project build directory (normally target).

When running as a reporting plugin, the output directory is fixed, set by the reporting cycle.


User property is: project.build.directory.
path String - If set only displays commits related to files found under this path.
plainTextChangeLogFilename String - The filename of the plain text changelog, if generated.
Default value is: changelog.txt.
reportTitle String - The title of the reports. Defaults to: ${project.name} v${project.version} changelog
Default value is: ${project.name} v${project.version} git changelog.
showCommiter boolean - Show the info about commiter (Default: false)
Default value is: true.
simpleHTMLChangeLogFilename String - The filename of the simple HTML changelog, if generated.
Default value is: changelog.html.
verbose boolean - If true, the changelog will be printed to the Maven build log during packaging.
Default value is: false.

Parameter Details

asciidocChangeLogFilename:

The filename of the Asciidoc changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: changelog.adoc

asciidocHeading:

asciidoc title level
  • Type: java.lang.String
  • Required: No
  • Default: =

asciidocHeadingReleaseNotes:

asciidoc title level
  • Type: java.lang.String
  • Required: No
  • Default: =

asciidocReleaseNotesFilename:

The filename of the Asciidoc changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: releaseNotes.adoc

asciidocTableView:

If true, the changelog will be in an asciidoc table
  • Type: boolean
  • Required: No
  • Default: false

asciidocTableViewHeader1:

asciidoc table header 1
  • Type: java.lang.String
  • Required: No
  • Default: Date

asciidocTableViewHeader1ReleaseNotes:

asciidoc table header 1
  • Type: java.lang.String
  • Required: No
  • Default: Date

asciidocTableViewHeader2:

asciidoc table header 2
  • Type: java.lang.String
  • Required: No
  • Default: Commit

asciidocTableViewHeader2ReleaseNotes:

asciidoc table header 2
  • Type: java.lang.String
  • Required: No
  • Default: Merge

asciidocTableViewReleaseNotes:

If true, the changelog will be in an asciidoc table
  • Type: boolean
  • Required: No
  • Default: false

bugzillaPattern:

Regexp pattern to extract the number from the message.

The default is: "Bug (\\d+)". Group 1 (the number) is used in links, so "?:" must be used any non relevant group, ex.: (?:Bug|UPDATE|FIX|ADD|NEW|#) ?#?(\d+)

  • Type: java.lang.String
  • Required: No
  • Default: Bug (\d+)

dateFormat:

Used to set date format in log messages.
  • Type: java.lang.String
  • Required: No
  • Default: yyyy-MM-dd HH:mm:ss Z

excludeCommiters:

Exclude in the changelog all commits by a given commiter
  • Type: java.util.List
  • Required: No

excludeCommitsPattern:

Regexp pattern to filter out commits (using Matcher.matches())
  • Type: java.lang.String
  • Required: No

fullGitMessage:

(no description)
  • Type: boolean
  • Required: No
  • Default: false

fullGitMessageReleaseNotes:

(no description)
  • Type: boolean
  • Required: No
  • Default: false

generatAsciidocChangeLog:

(no description)
  • Type: boolean
  • Required: No
  • Default: false

generatAsciidocReleaseNotes:

(no description)
  • Type: boolean
  • Required: No
  • Default: false

generateAsciidocChangeLog:

If true, then an Asciidoc changelog will be generated.
  • Type: boolean
  • Required: No
  • Default: false

generateAsciidocReleaseNotes:

If true, then an Asciidoc changelog will be generated.
  • Type: boolean
  • Required: No
  • Default: false

generateHTMLTableOnlyChangeLog:

If true, then an HTML changelog which contains only a table element will be generated. This incomplete HTML page is suitable for inclusion in other webpages, for example you may want to embed it in a wiki page.
  • Type: boolean
  • Required: No
  • Default: false

generateJSONChangeLog:

If true, then a JSON changelog will be generated.
  • Type: boolean
  • Required: No
  • Default: true

generateMarkdownChangeLog:

If true, then a markdown changelog will be generated.
  • Type: boolean
  • Required: No
  • Default: false

generatePlainTextChangeLog:

If true, then a plain text changelog will be generated.
  • Type: boolean
  • Required: No
  • Default: true

generateSimpleHTMLChangeLog:

If true, then a simple HTML changelog will be generated.
  • Type: boolean
  • Required: No
  • Default: true

htmlTableOnlyChangeLogFilename:

The filename of the HTML table changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: changelogtable.html

includeCommitsAfter:

Include in the changelog the commits after this parameter value.
  • Type: java.util.Date
  • Required: No
  • Default: 1970-01-01 00:00:00.0 AM

includeCommitsAfterCommit:

Include in the changelog the commits after the commit id of this parameter value.
  • Type: java.lang.String
  • Required: No

includeCommitsDuringTheLastDays:

Include in the changelog the commits which are newer than the given amount of days.
  • Type: java.lang.Integer
  • Required: No

issueManagementSystem:

Used to create links to your issue tracking system for HTML reports. If unspecified, it will try to use the value specified in the issueManagement section of your project's POM. The following values are supported: a value containing the string "github" for the GitHub Issue tracking software; a value containing the string "jira" for Jira tracking software. Any other value will result in no links being made.
  • Type: java.lang.String
  • Required: No
  • User Property: project.issueManagement.system

issueManagementUrl:

Used to create links to your issue tracking system for HTML reports. If unspecified, it will try to use the value specified in the issueManagement section of your project's POM.
  • Type: java.lang.String
  • Required: No
  • User Property: project.issueManagement.url

jiraPattern:

Regexp pattern to extract the number from the message.

The default is: "[A-Z]+-[0-9]+". Group 1 (the number) is used in links, so "?:" must be used any non relevant group,

  • Type: java.lang.String
  • Required: No
  • Default: [A-Z]+-[0-9]+

jsonChangeLogFilename:

The filename of the JSON changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: changelog.json

markdownChangeLogAppend:

Append info to existing markdown file (Default: false)
  • Type: boolean
  • Required: No
  • Default: false

markdownChangeLogFilename:

The filename of the markdown changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: changelog.md

mergeCommitFilter:

If true, the merge commit filter will be configured.
  • Type: boolean
  • Required: No
  • Default: true

mergeCommitFilterReleaseNotes:

If true, the merge commit filter will be configured.
  • Type: boolean
  • Required: No
  • Default: true

outputDirectory:

The directory to put the reports in. Defaults to the project build directory (normally target).

When running as a reporting plugin, the output directory is fixed, set by the reporting cycle.

  • Type: java.io.File
  • Required: No
  • User Property: project.build.directory

path:

If set only displays commits related to files found under this path.
  • Type: java.lang.String
  • Required: No

plainTextChangeLogFilename:

The filename of the plain text changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: changelog.txt

reportTitle:

The title of the reports. Defaults to: ${project.name} v${project.version} changelog
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name} v${project.version} git changelog

showCommiter:

Show the info about commiter (Default: false)
  • Type: boolean
  • Required: No
  • Default: true

simpleHTMLChangeLogFilename:

The filename of the simple HTML changelog, if generated.
  • Type: java.lang.String
  • Required: No
  • Default: changelog.html

verbose:

If true, the changelog will be printed to the Maven build log during packaging.
  • Type: boolean
  • Required: No
  • Default: false