You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by pk...@apache.org on 2024/09/01 08:54:32 UTC
(logging-log4j2) branch fix/2.24.0-documentation created (now f1f5b6113f)
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a change to branch fix/2.24.0-documentation
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
at f1f5b6113f Fix the documentation of the `2.24.0` release
This branch includes the following new commits:
new f1f5b6113f Fix the documentation of the `2.24.0` release
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(logging-log4j2) 01/01: Fix the documentation of the `2.24.0` release
Posted by pk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch fix/2.24.0-documentation
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit f1f5b6113feb093793783a196cf53afddf5f4d7e
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Sun Sep 1 10:54:20 2024 +0200
Fix the documentation of the `2.24.0` release
This PR addresses the concerns about the documentation of the `2.24.0`
released, expressed on [`dev@logging`](https://lists.apache.org/thread/jxc522x9qmg3xyokrk1nsng7q29pfjs3).
---
pom.xml | 27 +-----
src/changelog/2.24.0/.release-notes.adoc.ftl | 5 +-
src/site/antora/modules/ROOT/pages/download.adoc | 101 ++++++++++++++++++++-
src/site/antora/modules/ROOT/pages/manual/api.adoc | 8 --
4 files changed, 103 insertions(+), 38 deletions(-)
diff --git a/pom.xml b/pom.xml
index 2484cf995c..7e275c4516 100644
--- a/pom.xml
+++ b/pom.xml
@@ -343,9 +343,9 @@
<site-je.version>18.3.12</site-je.version>
<site-jeromq.version>0.6.0</site-jeromq.version>
<site-kafka.version>3.8.0</site-kafka.version>
- <site-log4j-api.version>2.23.1</site-log4j-api.version>
- <site-log4j-core.version>2.23.1</site-log4j-core.version>
- <site-log4j-layout-template-json.version>2.23.1</site-log4j-layout-template-json.version>
+ <site-log4j-api.version>2.24.0</site-log4j-api.version>
+ <site-log4j-core.version>2.24.0</site-log4j-core.version>
+ <site-log4j-layout-template-json.version>2.24.0</site-log4j-layout-template-json.version>
<site-logback.version>1.5.5</site-logback.version>
<site-slf4j.version>2.0.16</site-slf4j.version>
@@ -713,27 +713,6 @@
No, we cannot use `${project.version}`, because it is not released yet. -->
<dependencies>
- <!-- Log4j component dependencies.
- No, we cannot use `${project.version}`, because it is not released yet. -->
-
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-api</artifactId>
- <version>${site-log4j-api.version}</version>
- </dependency>
-
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-core</artifactId>
- <version>${site-log4j-core.version}</version>
- </dependency>
-
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-layout-template-json</artifactId>
- <version>${site-log4j-layout-template-json.version}</version>
- </dependency>
-
<!-- Other dependencies -->
<dependency>
diff --git a/src/changelog/2.24.0/.release-notes.adoc.ftl b/src/changelog/2.24.0/.release-notes.adoc.ftl
index 670578524c..caf821ef08 100644
--- a/src/changelog/2.24.0/.release-notes.adoc.ftl
+++ b/src/changelog/2.24.0/.release-notes.adoc.ftl
@@ -46,14 +46,15 @@ If such a functionality is required, it must be explicitly enabled.
The following Log4j Core additional modules have been removed:
`log4j-flume-ng`::
-The module has been moved to the Flume project and follows the Apache Flume release lifecycle.
+The module is no longer part of the release process and will follow its own release lifecycle.
+Please manage your dependencies using xref:components.adoc#log4j-bom[`log4j-bom`] to always use its latest version.
`log4j-kubernetes`::
The module has been moved to the https://github.com/fabric8io/kubernetes-client/blob/main/doc/KubernetesLog4j.md[Fabric8.io Kubernetes project] and follows the Fabric8.io release lifecycle.
`log4j-mongodb3`::
The module based on MongoDB Java client version 3.x has been removed.
-Please migrate to `log4j-mongodb` (client version 5.x) or `log4j-mongodb4` (client version 4.x).
+Please migrate to xref:components.adoc#log4j-mongodb[`log4j-mongodb`] (client version 5.x) or xref:components.adoc#log4j-mongodb4[`log4j-mongodb4`] (client version 4.x).
=== JMX changes
diff --git a/src/site/antora/modules/ROOT/pages/download.adoc b/src/site/antora/modules/ROOT/pages/download.adoc
index d85d7606fd..931ff9d2da 100644
--- a/src/site/antora/modules/ROOT/pages/download.adoc
+++ b/src/site/antora/modules/ROOT/pages/download.adoc
@@ -16,17 +16,110 @@
////
= Download
+:dist-url: https://downloads.apache.org/logging/log4j/{log4j-core-version}
-You can manually download all published Log4j distributions, verify them, and see their licensing information by following the instructions in {logging-services-url}/download.html[the Download page] of {logging-services-url}[Logging Services].
+Apache Log4j is distributed under the
+https://www.apache.org/licenses/LICENSE-2.0[Apache License, version 2.0].
+You can find the download links of the official <<source-distribution,source>> and <<binary-distribution,binary distributions>> below.
-* Are you looking for **the Log4j installation instructions**? Proceed to xref:manual/installation.adoc[].
-* Are you looking for the list of changes associated with a particular release? Proceed to xref:release-notes.adoc[].
+See also the {logging-services-url}/download.html[Logging Services download page] for instruction on how to validate the downloaded files.
+
+[TIP]
+====
+* Are you looking for **the Log4j installation instructions**?
+Proceed to xref:manual/installation.adoc[].
+* Are you looking for the list of changes associated with a particular release?
+Proceed to xref:release-notes.adoc[].
+====
+
+[#source-distribution]
+== Source distribution
+
+You can download the source code of the latest Apache Log4j release using the links below:
+
+.Source distribution files
+[cols="2h,5"]
+|===
+
+| Source distribution archive
+| {dist-url}/apache-log4j-{log4j-core-version}-src.zip[apache-log4j-{log4j-core-version}-src.zip]
+
+| Checksum
+| {dist-url}/apache-log4j-{log4j-core-version}-src.zip.sha256[apache-log4j-{log4j-core-version}-src.zip.sha256]
+
+| Signature
+| {dist-url}/apache-log4j-{log4j-core-version}-src.zip.asc[apache-log4j-{log4j-core-version}-src.zip.asc]
+
+| PGP keys
+| https://downloads.apache.org/logging/KEYS[KEYS]
+|===
+
+[#binary-distribution]
+== Binary distribution
+
+A set of binaries of Apache Log4j is available through two main distribution channels:
+
+ASF Nexus Repository::
++
+All the binary artifacts are available on the Apache Software Foundation
+https://repository.apache.org/content/repositories/releases/[`repository.apache.org` Nexus repository].
+Its content is mirrored to the
+https://repo.maven.apache.org/maven2[Maven Central repository].
++
+See xref:components.adoc[] for more information on the GAV coordinates of the artifacts.
+
+Binary distribution archive::
++
+All the artifacts in the ASF Nexus repository are also available in a single ZIP archive:
++
+.Binary distribution files
+[cols="2h,5"]
+|===
+
+| Source distribution archive
+| {dist-url}/apache-log4j-{log4j-core-version}-bin.zip[apache-log4j-{log4j-core-version}-bin.zip]
+
+| Checksum
+| {dist-url}/apache-log4j-{log4j-core-version}-bin.zip.sha256[apache-log4j-{log4j-core-version}-src.bin.sha256]
+
+| Signature
+| {dist-url}/apache-log4j-{log4j-core-version}-bin.zip.asc[apache-log4j-{log4j-core-version}-src.bin.asc]
+
+| PGP keys
+| https://downloads.apache.org/logging/KEYS[KEYS]
+|===
+
+[NOTE]
+====
+The authenticity of the Apache Log4j binary release is independently verified by the
+https://github.com/jvm-repo-rebuild/reproducible-central[Reproducible Builds for Maven Central Repository]
+project.
+You can check the reproducibility status of the artifacts on their
+https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/logging/log4j/log4j/README.md[`org.apache.logging.log4j:log4j` RB check] page.
+====
+
+[#sbom]
+== Software Bill of Materials (SBOM)
+
+Each Apache Log4j artifact is accompanied by a Software Bill of Materials in
+https://cyclonedx.org/[CycloneDX format].
+The SBOMs are published to the ASF Nexus repository with `cyclonedx` as classifier and `xml` as type and are also available in the binary distribution archive.
+
+See also {logging-services-url}/download.html#sbom[Apache Logging Services SBOMs].
+
+[IMPORTANT]
+====
+Since Apache Log4j is a software library, the contents of the SBOMs constitute only a **suggested** list of component versions known to work with Apache Log4j.
+These versions are used by our unit tests.
+
+The **effective** list of components included in an application containing Apache Log4j can only be determined by the producer of the application.
+====
[#older]
== Older releases
Are you looking for old versions of Log4j?
-While we recommend to always use the latest version, you can find the older versions here:
+While we recommend always using the latest version, you can find the older versions here:
* {logging-services-url}/log4j/1.x/index.html[Log4j 1.x (End of Life, Java 1.4)]
* {logging-services-url}/log4j/2.3.x/index.html[Log4j 2.3.x (Java 6)]
diff --git a/src/site/antora/modules/ROOT/pages/manual/api.adoc b/src/site/antora/modules/ROOT/pages/manual/api.adoc
index a4e9e656c3..525c5d54e0 100644
--- a/src/site/antora/modules/ROOT/pages/manual/api.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/api.adoc
@@ -282,14 +282,6 @@ include::example$manual/api/LoggerNameTest.java[tag=thread-context3,indent=0]
<4> Popping the last pushed property from the thread context stack
<5> Clearing the thread context (for both stack and map!)
-[WARNING]
-====
-**Thread Context is mostly superseded by Scoped Context**, which, unlike Thread Context,
-
-* is safe to use in servlet applications
-* can store any `Object`-typed value
-====
-
xref:manual/thread-context.adoc[Read more on Thread Context]...
[#messages]