[
https://issues.apache.org/jira/browse/MCHANGELOG-119?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17907294#comment-17907294
]
ASF GitHub Bot commented on MCHANGELOG-119:
-------------------------------------------
juulhobert commented on code in PR #21:
URL:
https://github.com/apache/maven-changelog-plugin/pull/21#discussion_r1893592263
##########
src/main/java/org/apache/maven/plugins/changelog/ChangeLogReport.java:
##########
@@ -283,6 +283,12 @@ public class ChangeLogReport extends AbstractMavenReport {
@Parameter(defaultValue = "connection", required = true)
private String connectionType;
+ /**
+ * If true, file and file revision information is displayed for each SCM
entry.
+ */
+ @Parameter(property = "displayFileAndRevInfo", defaultValue = "true")
+ private boolean displayFileAndRevInfo = true;
Review Comment:
It was matching the current behavior, so this was backwards compatible. From
code perspective I thought it would be nicer to rename it to
`hideFileAndRevInfo`. So now the default value is false which feels more logical
> Add option to disable displaying file and file revision information on report
> -----------------------------------------------------------------------------
>
> Key: MCHANGELOG-119
> URL: https://issues.apache.org/jira/browse/MCHANGELOG-119
> Project: Maven Changelog Plugin
> Issue Type: New Feature
> Affects Versions: 2.2
> Reporter: Ivan Mrva
> Priority: Major
> Attachments: changelog-disable-file-and-rev-info.diff,
> sample-report-with-disabled-file-and-rev-info.png
>
>
> Sometimes, it is better to not display all the information on the HTML
> report, such as file and file revision information, which makes the report
> unnecessarily long and less readable. For example, in our company, we would
> like to use this report as a changelog not only for developers, but also for
> testers, etc., who really don't care about concrete changed files and their
> revisions.
> This feature is especially useful, if used in connection with feature
> described in MCHANGELOG-118.
> I am submitting a very simple patch that implements this feature by providing
> one new configuration parameter:
> * *displayFileAndRevInfo* - If true, file and file revision information is
> displayed for each SCM entry.
> ** default value: true - so current behavior of report generation will not be
> changed, unless explicitly specified in configuration
> Patch also contains integration tests that test if report is created, if this
> param is used.
> Example report without file and file revision information is displayed on
> attached screenshot.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
