Improve release notes

Author: vy

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?capitalize}]
 === ${entryType?capitalize}
 
 <#list entries as entry>

src/changelog/2.22.0/.release-notes.adoc.ftl

@@ -20,6 +20,19 @@
 
 <#if release.date?has_content>Release date:: ${release.date}</#if>
 
-This releases contains bug fixes addressing issues in the JPMS & OSGi infrastructure overhauled in `2.21.0`, dependency updates, and some other minor fixes and improvements.
+:cyclonedx-sbom-link: https://cyclonedx.org/capabilities/sbom/[CycloneDX Software Bill of Materials (SBOM)]
+:cyclonedx-vdr-link: https://cyclonedx.org/capabilities/vdr[CycloneDX Vulnerability Disclosure Report (VDR)]
+
+This releases provides a {cyclonedx-sbom-link} along with each artifact and contains bug fixes addressing issues in the JPMS & OSGi infrastructure overhauled in `2.21.0`, dependency updates, and some other minor fixes and improvements.
+
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}-sbom]
+=== CycloneDX Software Bill of Materials (SBOM)
+
+This is _the first Log4j release_ that provides a {cyclonedx-sbom-link} along with each artifact.
+Generated SBOMs are attached as artifacts with `cyclonedx` classifier and XML extensions, that is, `<artifactId>-<version>-cyclonedx.xml`.
+They contain `vulnerability-assertion` references to a {cyclonedx-vdr-link} that Apache Logging Services uses for all projects it maintains.
+This VDR is accessible through the following URL: https://logging.apache.org/cyclonedx/vdr.xml[]
+
+SBOM generation is streamlined by `logging-parent`, see https://logging.apache.org/logging-parent/latest/#cyclonedx-sbom[its website] for details.
 
 <#include "../.changelog.adoc.ftl">

src/site/_release-notes/_2.0-alpha1.adoc

@@ -39,10 +39,12 @@
 Release date:: 2012-07-29
 
 
+[#release-notes-2-0-alpha1-Added]
 === Added
 
 * Added ability to filter on the AppenderRef by adding either a level or a filter. (https://issues.apache.org/jira/browse/LOG4J2-60[LOG4J2-60])
 
+[#release-notes-2-0-alpha1-Fixed]
 === Fixed
 
 * Make sure all application facing log methods use their own FQCN. This patch resolves a unit test failure for the %C pattern when using the Category logger. (https://issues.apache.org/jira/browse/LOG4J2-50[LOG4J2-50])

src/site/_release-notes/_2.0-alpha2.adoc

@@ -39,13 +39,15 @@
 Release date:: 2012-08-24
 
 
+[#release-notes-2-0-alpha2-Added]
 === Added
 
 * Allow components besides core to create a PluginMap for faster plugin loading and not having to specify the plugin package in the configuration. (https://issues.apache.org/jira/browse/LOG4J2-67[LOG4J2-67])
 * Add support for formatting using String.format(). (https://issues.apache.org/jira/browse/LOG4J2-68[LOG4J2-68])
 * Allow Flume agents to be embedded into the Flume Appender. (https://issues.apache.org/jira/browse/LOG4J2-69[LOG4J2-69])
 * Add getLogger(Class) to LogManager. (https://issues.apache.org/jira/browse/LOG4J2-70[LOG4J2-70])
 
+[#release-notes-2-0-alpha2-Fixed]
 === Fixed
 
 * Fix compilation problems in Java 7. (https://issues.apache.org/jira/browse/LOG4J2-64[LOG4J2-64])

src/site/_release-notes/_2.0-beta1.adoc

@@ -39,14 +39,17 @@
 Release date:: 2012-09-18
 
 
+[#release-notes-2-0-beta1-Added]
 === Added
 
 * Added AsynchAppender.
 
+[#release-notes-2-0-beta1-Changed]
 === Changed
 
 * Update the versions of SLF4J and Logback.
 
+[#release-notes-2-0-beta1-Fixed]
 === Fixed
 
 * Created web module to allow web applications to include the Log4j context listener in WEB-INF/lib even if Log4j is in the container's class path. Allow locating the LoggerContext to include the ClassLoader. Updated the Loader utility to always choose the child ClassLoader. Verified in Jboss 5 and Tomcat.

src/site/_release-notes/_2.0-beta2.adoc

@@ -39,6 +39,7 @@
 Release date:: 2012-10-07
 
 
+[#release-notes-2-0-beta2-Added]
 === Added
 
 * Add getFormats to MultiformatMessage and allow StructuredDataMessage to format as XML.
@@ -49,10 +50,12 @@ Release date:: 2012-10-07
 * If system property "disableThreadContextMap" is set puts to the ThreadContext will be ignored. If system property "disableThreadContext" is set both puts and pushes will be ignored. (https://issues.apache.org/jira/browse/LOG4J2-83[LOG4J2-83])
 * If system property "disableThreadContextStack" is set pushes to the ThreadContext will be ignored. If system property "disableThreadContext" is set both puts and pushes will be ignored. (https://issues.apache.org/jira/browse/LOG4J2-84[LOG4J2-84])
 
+[#release-notes-2-0-beta2-Changed]
 === Changed
 
 * Made ParameterizedMessage, StringFormattedMessage and ThreadDumpMessage immutable. LocalizedMessage is immutable except that it will be updated with the logger name when it is added to the LogEvent.
 
+[#release-notes-2-0-beta2-Fixed]
 === Fixed
 
 * DefaultConfiguration was not starting the Console Appender.

src/site/_release-notes/_2.0-beta3.adoc

@@ -39,11 +39,13 @@
 Release date:: 2012-11-11
 
 
+[#release-notes-2-0-beta3-Added]
 === Added
 
 * Added PropertiesRewritePolicy and ability to define properties on a Logger. (https://issues.apache.org/jira/browse/LOG4J2-28[LOG4J2-28])
 * Added ability to configure from an InputSource. (https://issues.apache.org/jira/browse/LOG4J2-55[LOG4J2-55])
 
+[#release-notes-2-0-beta3-Changed]
 === Changed
 
 * Created combined jar to combine API and Core contents for users who only want the Log4j implementation.
@@ -52,6 +54,7 @@ Release date:: 2012-11-11
 * Add ThreadContext.push(String format, Object... args) (https://issues.apache.org/jira/browse/LOG4J2-85[LOG4J2-85])
 * Build pdf of user's guide. (https://issues.apache.org/jira/browse/LOG4J2-87[LOG4J2-87])
 
+[#release-notes-2-0-beta3-Fixed]
 === Fixed
 
 * Avoid NPE when duplicate LoggerContextFactorys are present. Allow factories to specify a weight to allow real implementations to outrank test implementations. Provide a simple default LoggerContextFactory.

src/site/_release-notes/_2.0-beta4.adoc

@@ -39,6 +39,7 @@
 Release date:: 2013-01-28
 
 
+[#release-notes-2-0-beta4-Added]
 === Added
 
 * Add MessageFormatMessage and FormattedMessage.
@@ -49,13 +50,15 @@ Release date:: 2013-01-28
 * Allow custom message creation via a message factory. (https://issues.apache.org/jira/browse/LOG4J2-133[LOG4J2-133])
 * Use %red, %white, %blue, and so on in the console appender. (https://issues.apache.org/jira/browse/LOG4J2-134[LOG4J2-134])
 
+[#release-notes-2-0-beta4-Changed]
 === Changed
 
 * Renamed log4j12-api to log4j-1.2-api. (https://issues.apache.org/jira/browse/LOG4J2-110[LOG4J2-110])
 * Add unit test to verify exceptions are thrown when the socket connection fails. (https://issues.apache.org/jira/browse/LOG4J2-122[LOG4J2-122])
 * Add follow attribute to Console Appender. (https://issues.apache.org/jira/browse/LOG4J2-128[LOG4J2-128])
 * Allow newlines to be escaped in Syslog and RFC5424 layouts. Allow Throwables to be included in the output from RFC5424Layout. (https://issues.apache.org/jira/browse/LOG4J2-136[LOG4J2-136])
 
+[#release-notes-2-0-beta4-Fixed]
 === Fixed
 
 * Allow FlumeAvroManager to initialize even if it cannot connect to an agent.

src/site/_release-notes/_2.0-beta5.adoc

@@ -39,6 +39,7 @@
 Release date:: 2013-04-20
 
 
+[#release-notes-2-0-beta5-Added]
 === Added
 
 * Added FlumePersistentManager which writes to BerkeleyDB and then writes to Flume asynchronously.
@@ -49,6 +50,7 @@ Release date:: 2013-04-20
 * Add tag library. (https://issues.apache.org/jira/browse/LOG4J2-187[LOG4J2-187])
 * Add JMX support. (https://issues.apache.org/jira/browse/LOG4J2-207[LOG4J2-207])
 
+[#release-notes-2-0-beta5-Changed]
 === Changed
 
 * Allow Logger and LoggerContext to be subclassed. (https://issues.apache.org/jira/browse/LOG4J2-151[LOG4J2-151])
@@ -59,6 +61,7 @@ Release date:: 2013-04-20
 * Move async subproject into core. (https://issues.apache.org/jira/browse/LOG4J2-208[LOG4J2-208])
 * Async documentation update. (https://issues.apache.org/jira/browse/LOG4J2-214[LOG4J2-214])
 
+[#release-notes-2-0-beta5-Fixed]
 === Fixed
 
 * Add Fragment-Host to MANIFEST.MF for log4j-core. (https://issues.apache.org/jira/browse/LOG4J2-159[LOG4J2-159])

src/site/_release-notes/_2.0-beta6.adoc

@@ -39,6 +39,7 @@
 Release date:: 2013-05-05
 
 
+[#release-notes-2-0-beta6-Changed]
 === Changed
 
 * Documentation updates to clarify use and impact of location in pattern layouts. (https://issues.apache.org/jira/browse/LOG4J2-225[LOG4J2-225])
@@ -48,6 +49,7 @@ Release date:: 2013-05-05
 * Removed CheckStyle false positives for NewlineAtEndOfFile and whitespace following '*' at end of line in javadoc.
 * Renamed AsynchAppender to AsyncAppender. Plugin name became Async (was Asynch).
 
+[#release-notes-2-0-beta6-Fixed]
 === Fixed
 
 * Use OSGi version format in Fragment-Host (https://issues.apache.org/jira/browse/LOG4J2-159[LOG4J2-159])