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/07 11:50:25 UTC

[logging-log4j2] branch release-2.x updated: Rename changelog exports to "Release Notes"

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

vy pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/release-2.x by this push:
     new 006cfeea53 Rename changelog exports to "Release Notes"
006cfeea53 is described below

commit 006cfeea532d754f1d738f5cbb67f3d705cfd9ee
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Feb 7 12:51:44 2023 +0100

    Rename changelog exports to "Release Notes"
---
 pom.xml                                   | 5 ++++-
 src/changelog/.changelog-entries.adoc.ftl | 2 +-
 src/changelog/.index.adoc.ftl             | 2 +-
 src/site/markdown/index.md.vm             | 2 +-
 src/site/site.xml                         | 2 +-
 5 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/pom.xml b/pom.xml
index af99803f5c..8f02065c61 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1622,11 +1622,14 @@
            This section consists of plugins responsible for generating the site.
            Note that only parent is supposed to have a `site` goal, it is skipped for modules! -->
 
-      <!-- export AsciiDoc-formatted sources to `target/generated-sources/site/asciidoc/changelog` -->
+      <!-- export AsciiDoc-formatted sources to `target/generated-sources/site/asciidoc/release-notes` -->
       <plugin>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-changelog-maven-plugin</artifactId>
         <inherited>false</inherited>
+        <configuration>
+          <outputDirectory>${project.build.directory}/generated-sources/site/asciidoc/release-notes</outputDirectory>
+        </configuration>
         <executions>
           <execution>
             <id>generate-changelog</id>
diff --git a/src/changelog/.changelog-entries.adoc.ftl b/src/changelog/.changelog-entries.adoc.ftl
index 21f30ed651..53378df5b1 100644
--- a/src/changelog/.changelog-entries.adoc.ftl
+++ b/src/changelog/.changelog-entries.adoc.ftl
@@ -17,7 +17,7 @@
 <#if entriesByType?size gt 0>== Changes
 <#list entriesByType as entryType, entries>
 
-== ${entryType?capitalize}
+=== ${entryType?capitalize}
 
 <#list entries as entry>
 * ${entry.description.text?replace("\\s+", " ", "r")} (for <@compress single_line=true>
diff --git a/src/changelog/.index.adoc.ftl b/src/changelog/.index.adoc.ftl
index e6e82babd3..f6819e0a58 100644
--- a/src/changelog/.index.adoc.ftl
+++ b/src/changelog/.index.adoc.ftl
@@ -15,7 +15,7 @@
     limitations under the License.
 ////
 
-= Release changelogs
+= Release Notes
 
 <#list releases as release>
 * xref:${release.changelogFileName}[${release.version}]<#if release.date?has_content> (${release.date})</#if>
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index e37559985b..a6cb51313d 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -184,6 +184,6 @@ Adapters are also available for Apache Commons Logging, SLF4J, and java.util.log
 
 Log4j $Log4jReleaseVersion is the latest release of Log4j. As of Log4j 2.13.0 Log4j 2 requires Java 8 or greater at
 runtime.
-This release contains new features and fixes which are explained further in [changelogs](changelog/).
+This release contains new features and fixes which are explained further in [release notes](release-notes).
 
 Log4j $Log4jReleaseVersion maintains binary compatibility with previous releases.
diff --git a/src/site/site.xml b/src/site/site.xml
index 36c3e585d5..282e2a21ab 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -60,7 +60,7 @@
         <item name="Snapshot builds" href="/maven-artifacts.html#Snapshot_builds" />
       </item>
       <item name="Runtime Dependencies" href="/runtime-dependencies.html"/>
-      <item name="Changelog" href="/changelog/"/>
+      <item name="Release Notes" href="/release-notes/"/>
       <item name="FAQ" href="/faq.html"/>
       <item name="Performance" href="/performance.html" collapse="true">
         <item name="Benchmarks" href="/performance.html#benchmarks" />