Improve changelog

apache · Nov 17, 2023 · ad2cb91 · ad2cb91
1 parent ea67159
commit ad2cb91
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 0 deletions.
diff --git a/src/changelog/.changelog.adoc.ftl b/src/changelog/.changelog.adoc.ftl
@@ -17,6 +17,7 @@
 <#if entriesByType?size gt 0>
 <#list entriesByType as entryType, entries>
 
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}-${entryType?lower_case}]
 ==== ${entryType?capitalize}
 
 <#list entries as entry>

diff --git a/src/site/_release-notes/_0.1.0.adoc b/src/site/_release-notes/_0.1.0.adoc
@@ -41,6 +41,7 @@ Release date:: 2023-01-10
 This is the first release, aimed to assist [the Apache Log4j 2](http://logging.apache.org/log4j/2.x/) on generating release notes.
 
 
+[#release-notes-0-1-0-added]
 ==== Added
 
 * Add `log4j-tools-bom` and `log4j-changelog` modules (https://issues.apache.org/jira/browse/LOG4J2-3628[LOG4J2-3628])
diff --git a/src/site/_release-notes/_0.2.0.adoc b/src/site/_release-notes/_0.2.0.adoc
@@ -41,19 +41,23 @@ Release date:: 2023-01-31
 This minor release contains various bug fixes and improvements.
 
 
+[#release-notes-0-2-0-added]
 ==== Added
 
 * Add XSD for `log4j-changelog` XML files (https://github.com/apache/logging-log4j-tools/issues/13[13])
 * Add `log4j-changelog-maven-plugin` module (https://github.com/apache/logging-log4j-tools/issues/20[20])
 
+[#release-notes-0-2-0-changed]
 ==== Changed
 
 * Rename `log4j.changelog.exporter.outputDirectory` property to `log4j.changelog.outputDirectory` (https://github.com/apache/logging-log4j-tools/issues/20[20])
 
+[#release-notes-0-2-0-removed]
 ==== Removed
 
 * Remove `security` as a change type from `log4j-changelog` (https://github.com/apache/logging-log4j-tools/issues/14[14])
 
+[#release-notes-0-2-0-fixed]
 ==== Fixed
 
 * Fix unreleased directory order in `ChangelogExporter` (https://github.com/apache/logging-log4j-tools/issues/17[17])

diff --git a/src/site/_release-notes/_0.3.0.adoc b/src/site/_release-notes/_0.3.0.adoc
@@ -41,11 +41,13 @@ Release date:: 2023-03-14
 This minor release contains various bug fixes and improvements.
 
 
+[#release-notes-0-3-0-added]
 ==== Added
 
 * The changelog release models passed to the index template file (`.index.adoc.ftl`) is enriched with `changelogEntryCount` fields (https://github.com/apache/logging-log4j-tools/issues/37[37])
 * Support multiple and formatting-agnostic template files (https://github.com/apache/logging-log4j-tools/issues/44[44])
 
+[#release-notes-0-3-0-changed]
 ==== Changed
 
 * Upgrade the compiler version to Java 17, yet still target Java 8
diff --git a/src/site/_release-notes/_0.4.0.adoc b/src/site/_release-notes/_0.4.0.adoc
@@ -42,15 +42,18 @@ This minor release contains small enhancements.
 Most importantly, this marks the first release where the project uses itself to generate release notes!
 
 
+[#release-notes-0-4-0-added]
 ==== Added
 
 * Add `versionPattern` (i.e., the regular expression pattern for parsing versions) parameter to the Maven `release` goal (https://github.com/apache/logging-log4j-tools/issues/63[63])
 
+[#release-notes-0-4-0-changed]
 ==== Changed
 
 * Change the default value of `outputDirectory` to `${project.build.directory}/generated-sources/site/changelog` for the Maven `export` goal
 * Migrate from `CHANGELOG.adoc` to using `log4j-changelog-maven-plugin`
 
+[#release-notes-0-4-0-fixed]
 ==== Fixed
 
 * Improve Maven `release` goal to accommodate repetitive invocations
diff --git a/src/site/_release-notes/_0.5.0.adoc b/src/site/_release-notes/_0.5.0.adoc
@@ -41,11 +41,13 @@ Release date:: 2023-09-29
 This minor release contains various bug fixes and improvements.
 
 
+[#release-notes-0-5-0-added]
 ==== Added
 
 * Added OSGi and JPMS support
 * Started publishing https://logging.apache.org/log4j/tools[the project website]
 
+[#release-notes-0-5-0-changed]
 ==== Changed
 
 * Made `author` element optional and bumped the XML schema version to `0.1.2` (https://github.com/apache/logging-log4j-tools/issues/81[81])

diff --git a/src/site/_release-notes/_0.6.0.adoc b/src/site/_release-notes/_0.6.0.adoc
@@ -41,14 +41,17 @@ Release date:: 2023-11-15
 This minor release contains various bug fixes and improvements.
 
 
+[#release-notes-0-6-0-added]
 ==== Added
 
 * Started generating CycloneDX SBOM with the recent update of `logging-parent` to version `10.4.0`
 
+[#release-notes-0-6-0-changed]
 ==== Changed
 
 * Update `org.apache.logging:logging-parent` to version `10.4.0`
 
+[#release-notes-0-6-0-fixed]
 ==== Fixed
 
 * `log4j-tools-bom` was broken due to removed `parent` during flattening. This is automatically fixed by the recent `logging-parent` version `10.4.0` update.