You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2023/02/23 21:26:53 UTC

[logging-log4j-tools] 02/02: Add `changelogEntryCount` field to the model passed to `.index.adoc.ftl` (#37)

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git

commit 750277d6f9ea8bc9afa4738326f2e7d5527d2181
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Thu Feb 23 22:28:27 2023 +0100

    Add `changelogEntryCount` field to the model passed to `.index.adoc.ftl` (#37)
---
 CHANGELOG.adoc                                     |  4 ++++
 .../changelog/exporter/ChangelogExporter.java      | 26 +++++++++++++++++-----
 .../.changelog.adoc.ftl}                           |  8 +++----
 .../src/test/resources/3-enriched/.index.adoc.ftl  |  4 ++--
 .../.index.adoc.ftl => 4-exported/4.x.x.adoc}      |  7 +++---
 .../.4.x.x/.changelog.adoc.ftl}                    |  8 +++----
 .../src/test/resources/5-released/.index.adoc.ftl  |  4 ++--
 7 files changed, 40 insertions(+), 21 deletions(-)

diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
index 3ecd781..ca675b3 100644
--- a/CHANGELOG.adoc
+++ b/CHANGELOG.adoc
@@ -15,6 +15,10 @@ See the License for the specific language governing permissions and
 limitations under the License.
 ////
 
+== 0.x.x
+
+* The changelog release models passed to the index template file (`.index.adoc.ftl`) is enriched with `changelogEntryCount` fields (for https://github.com/apache/logging-log4j-tools/issues/37[#37] by Volkan Yazıcı)
+
 == 0.2.0 (2023-01-31)
 
 * Fixed Windows compatibility (for https://github.com/apache/logging-log4j-tools/issues/19[#19] by Piotr P. Karwasz, Volkan Yazıcı)
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporter.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporter.java
index a2341d8..dc367a4 100644
--- a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporter.java
+++ b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporter.java
@@ -53,6 +53,10 @@ public final class ChangelogExporter {
                     return ChangelogRelease.readFromXmlFile(releaseXmlFile);
                 })
                 .collect(Collectors.toList());
+        final List<Integer> changelogEntryCounts = releaseDirectories
+                .stream()
+                .map(ignored -> 0)
+                .collect(Collectors.toList());
 
         // Export releases
         if (releaseDirectoryCount > 0) {
@@ -62,8 +66,9 @@ public final class ChangelogExporter {
                 final Path releaseDirectory = releaseDirectories.get(releaseIndex);
                 final ChangelogRelease changelogRelease = changelogReleases.get(releaseIndex);
                 final Path releaseChangelogTemplateFile = ChangelogFiles.releaseChangelogTemplateFile(releaseDirectory);
+                final int changelogEntryCount;
                 try {
-                    exportRelease(
+                    changelogEntryCount = exportRelease(
                             args.outputDirectory,
                             args.changelogDirectory,
                             releaseDirectory,
@@ -74,6 +79,7 @@ public final class ChangelogExporter {
                             String.format("failed exporting release from directory `%s`", releaseDirectory);
                     throw new RuntimeException(message, error);
                 }
+                changelogEntryCounts.set(releaseIndex, changelogEntryCount);
             }
 
             // Report the operation
@@ -100,20 +106,22 @@ public final class ChangelogExporter {
                     final Path upcomingReleaseChangelogTemplateFile =
                             ChangelogFiles.releaseChangelogTemplateFile(upcomingReleaseDirectory);
                     System.out.format("exporting upcoming release directory: `%s`%n", upcomingReleaseDirectory);
-                    exportRelease(
+                    final int changelogEntryCount = exportRelease(
                             args.outputDirectory,
                             args.changelogDirectory,
                             upcomingReleaseDirectory,
                             upcomingRelease,
                             upcomingReleaseChangelogTemplateFile);
                     changelogReleases.add(upcomingRelease);
+                    changelogEntryCounts.add(changelogEntryCount);
                 });
 
         // Export the release index
         exportIndex(
                 args.outputDirectory,
                 args.changelogDirectory,
-                changelogReleases);
+                changelogReleases,
+                changelogEntryCounts);
 
     }
 
@@ -136,7 +144,7 @@ public final class ChangelogExporter {
                 FileUtils.findAdjacentFiles(path, false, paths -> paths.findFirst().isPresent());
     }
 
-    private static void exportRelease(
+    private static int exportRelease(
             final Path outputDirectory,
             final Path changelogDirectory,
             final Path releaseDirectory,
@@ -155,6 +163,11 @@ public final class ChangelogExporter {
             final String message = String.format("failed exporting release from directory `%s`", releaseDirectory);
             throw new UncheckedIOException(message, error);
         }
+        return changelogEntriesByType
+                .values()
+                .stream()
+                .mapToInt(Collection::size)
+                .sum();
     }
 
     private static Map<ChangelogEntry.Type, List<ChangelogEntry>> readChangelogEntriesByType(
@@ -198,7 +211,8 @@ public final class ChangelogExporter {
     private static void exportIndex(
             final Path outputDirectory,
             final Path changelogDirectory,
-            final List<ChangelogRelease> changelogReleases) {
+            final List<ChangelogRelease> changelogReleases,
+            final List<Integer> changelogEntryCounts) {
         final Object indexTemplateData = Collections.singletonMap(
                 "releases", IntStream
                         .range(0, changelogReleases.size())
@@ -206,9 +220,11 @@ public final class ChangelogExporter {
                         .sorted(Comparator.reverseOrder())
                         .map(releaseIndex -> {
                             final ChangelogRelease changelogRelease = changelogReleases.get(releaseIndex);
+                            final int changelogEntryCount = changelogEntryCounts.get(releaseIndex);
                             Map<String, Object> changelogReleaseData = new LinkedHashMap<>();
                             changelogReleaseData.put("version", changelogRelease.version);
                             changelogReleaseData.put("date", changelogRelease.date);
+                            changelogReleaseData.put("changelogEntryCount", changelogEntryCount);
                             changelogReleaseData.put("changelogFileName", releaseChangelogFileName(changelogRelease));
                             return (Object) changelogReleaseData;
                         })
diff --git a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl b/log4j-changelog/src/test/resources/3-enriched/.4.x.x/.changelog.adoc.ftl
similarity index 81%
copy from log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
copy to log4j-changelog/src/test/resources/3-enriched/.4.x.x/.changelog.adoc.ftl
index e6e82ba..c4097db 100644
--- a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
+++ b/log4j-changelog/src/test/resources/3-enriched/.4.x.x/.changelog.adoc.ftl
@@ -15,8 +15,8 @@
     limitations under the License.
 ////
 
-= Release changelogs
+= ${release.version}<#if release.date?has_content> (${release.date})</#if>
 
-<#list releases as release>
-* xref:${release.changelogFileName}[${release.version}]<#if release.date?has_content> (${release.date})</#if>
-</#list>
+Changes staged for the next 4.x.x version that is yet to be released.
+
+<#include "../.changelog-entries.adoc.ftl">
diff --git a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl b/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
index e6e82ba..27d0149 100644
--- a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
+++ b/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
@@ -17,6 +17,6 @@
 
 = Release changelogs
 
-<#list releases as release>
+<#list releases as release><#if release.changelogEntryCount gt 0>
 * xref:${release.changelogFileName}[${release.version}]<#if release.date?has_content> (${release.date})</#if>
-</#list>
+</#if></#list>
diff --git a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl b/log4j-changelog/src/test/resources/4-exported/4.x.x.adoc
similarity index 82%
copy from log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
copy to log4j-changelog/src/test/resources/4-exported/4.x.x.adoc
index e6e82ba..ca6e58d 100644
--- a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
+++ b/log4j-changelog/src/test/resources/4-exported/4.x.x.adoc
@@ -15,8 +15,7 @@
     limitations under the License.
 ////
 
-= Release changelogs
+= 4.x.x
+
+Changes staged for the next 4.x.x version that is yet to be released.
 
-<#list releases as release>
-* xref:${release.changelogFileName}[${release.version}]<#if release.date?has_content> (${release.date})</#if>
-</#list>
diff --git a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl b/log4j-changelog/src/test/resources/5-released/.4.x.x/.changelog.adoc.ftl
similarity index 81%
copy from log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
copy to log4j-changelog/src/test/resources/5-released/.4.x.x/.changelog.adoc.ftl
index e6e82ba..c4097db 100644
--- a/log4j-changelog/src/test/resources/3-enriched/.index.adoc.ftl
+++ b/log4j-changelog/src/test/resources/5-released/.4.x.x/.changelog.adoc.ftl
@@ -15,8 +15,8 @@
     limitations under the License.
 ////
 
-= Release changelogs
+= ${release.version}<#if release.date?has_content> (${release.date})</#if>
 
-<#list releases as release>
-* xref:${release.changelogFileName}[${release.version}]<#if release.date?has_content> (${release.date})</#if>
-</#list>
+Changes staged for the next 4.x.x version that is yet to be released.
+
+<#include "../.changelog-entries.adoc.ftl">
diff --git a/log4j-changelog/src/test/resources/5-released/.index.adoc.ftl b/log4j-changelog/src/test/resources/5-released/.index.adoc.ftl
index e6e82ba..27d0149 100644
--- a/log4j-changelog/src/test/resources/5-released/.index.adoc.ftl
+++ b/log4j-changelog/src/test/resources/5-released/.index.adoc.ftl
@@ -17,6 +17,6 @@
 
 = Release changelogs
 
-<#list releases as release>
+<#list releases as release><#if release.changelogEntryCount gt 0>
 * xref:${release.changelogFileName}[${release.version}]<#if release.date?has_content> (${release.date})</#if>
-</#list>
+</#if></#list>