Skip to content

Commit 5250a47

Browse files
committed
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).
1 parent 0805368 commit 5250a47

File tree

4 files changed

+103
-38
lines changed

4 files changed

+103
-38
lines changed

pom.xml

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -343,9 +343,9 @@
343343
<site-je.version>18.3.12</site-je.version>
344344
<site-jeromq.version>0.6.0</site-jeromq.version>
345345
<site-kafka.version>3.8.0</site-kafka.version>
346-
<site-log4j-api.version>2.23.1</site-log4j-api.version>
347-
<site-log4j-core.version>2.23.1</site-log4j-core.version>
348-
<site-log4j-layout-template-json.version>2.23.1</site-log4j-layout-template-json.version>
346+
<site-log4j-api.version>2.24.0</site-log4j-api.version>
347+
<site-log4j-core.version>2.24.0</site-log4j-core.version>
348+
<site-log4j-layout-template-json.version>2.24.0</site-log4j-layout-template-json.version>
349349
<site-logback.version>1.5.5</site-logback.version>
350350
<site-slf4j.version>2.0.16</site-slf4j.version>
351351

@@ -713,27 +713,6 @@
713713
No, we cannot use `${project.version}`, because it is not released yet. -->
714714
<dependencies>
715715

716-
<!-- Log4j component dependencies.
717-
No, we cannot use `${project.version}`, because it is not released yet. -->
718-
719-
<dependency>
720-
<groupId>org.apache.logging.log4j</groupId>
721-
<artifactId>log4j-api</artifactId>
722-
<version>${site-log4j-api.version}</version>
723-
</dependency>
724-
725-
<dependency>
726-
<groupId>org.apache.logging.log4j</groupId>
727-
<artifactId>log4j-core</artifactId>
728-
<version>${site-log4j-core.version}</version>
729-
</dependency>
730-
731-
<dependency>
732-
<groupId>org.apache.logging.log4j</groupId>
733-
<artifactId>log4j-layout-template-json</artifactId>
734-
<version>${site-log4j-layout-template-json.version}</version>
735-
</dependency>
736-
737716
<!-- Other dependencies -->
738717

739718
<dependency>

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,15 @@ If such a functionality is required, it must be explicitly enabled.
4646
The following Log4j Core additional modules have been removed:
4747

4848
`log4j-flume-ng`::
49-
The module has been moved to the Flume project and follows the Apache Flume release lifecycle.
49+
The module is no longer part of the release process and will follow its own release lifecycle.
50+
Please manage your dependencies using xref:components.adoc#log4j-bom[`log4j-bom`] to always use its latest version.
5051

5152
`log4j-kubernetes`::
5253
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.
5354

5455
`log4j-mongodb3`::
5556
The module based on MongoDB Java client version 3.x has been removed.
56-
Please migrate to `log4j-mongodb` (client version 5.x) or `log4j-mongodb4` (client version 4.x).
57+
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).
5758

5859
=== JMX changes
5960

src/site/antora/modules/ROOT/pages/download.adoc

Lines changed: 97 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,110 @@
1616
////
1717
1818
= Download
19+
:dist-url: https://downloads.apache.org/logging/log4j/{log4j-core-version}
1920
20-
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].
21+
Apache Log4j is distributed under the
22+
https://www.apache.org/licenses/LICENSE-2.0[Apache License, version 2.0].
23+
You can find the download links of the official <<source-distribution,source>> and <<binary-distribution,binary distributions>> below.
2124
22-
* Are you looking for **the Log4j installation instructions**? Proceed to xref:manual/installation.adoc[].
23-
* Are you looking for the list of changes associated with a particular release? Proceed to xref:release-notes.adoc[].
25+
See also the {logging-services-url}/download.html[Logging Services download page] for instruction on how to validate the downloaded files.
26+
27+
[TIP]
28+
====
29+
* Are you looking for **the Log4j installation instructions**?
30+
Proceed to xref:manual/installation.adoc[].
31+
* Are you looking for the list of changes associated with a particular release?
32+
Proceed to xref:release-notes.adoc[].
33+
====
34+
35+
[#source-distribution]
36+
== Source distribution
37+
38+
You can download the source code of the latest Apache Log4j release using the links below:
39+
40+
.Source distribution files
41+
[cols="2h,5"]
42+
|===
43+
44+
| Source distribution archive
45+
| {dist-url}/apache-log4j-{log4j-core-version}-src.zip[apache-log4j-{log4j-core-version}-src.zip]
46+
47+
| Checksum
48+
| {dist-url}/apache-log4j-{log4j-core-version}-src.zip.sha256[apache-log4j-{log4j-core-version}-src.zip.sha256]
49+
50+
| Signature
51+
| {dist-url}/apache-log4j-{log4j-core-version}-src.zip.asc[apache-log4j-{log4j-core-version}-src.zip.asc]
52+
53+
| PGP keys
54+
| https://downloads.apache.org/logging/KEYS[KEYS]
55+
|===
56+
57+
[#binary-distribution]
58+
== Binary distribution
59+
60+
A set of binaries of Apache Log4j is available through two main distribution channels:
61+
62+
ASF Nexus Repository::
63+
+
64+
All the binary artifacts are available on the Apache Software Foundation
65+
https://repository.apache.org/content/repositories/releases/[`repository.apache.org` Nexus repository].
66+
Its content is mirrored to the
67+
https://repo.maven.apache.org/maven2[Maven Central repository].
68+
+
69+
See xref:components.adoc[] for more information on the GAV coordinates of the artifacts.
70+
71+
Binary distribution archive::
72+
+
73+
All the artifacts in the ASF Nexus repository are also available in a single ZIP archive:
74+
+
75+
.Binary distribution files
76+
[cols="2h,5"]
77+
|===
78+
79+
| Source distribution archive
80+
| {dist-url}/apache-log4j-{log4j-core-version}-bin.zip[apache-log4j-{log4j-core-version}-bin.zip]
81+
82+
| Checksum
83+
| {dist-url}/apache-log4j-{log4j-core-version}-bin.zip.sha256[apache-log4j-{log4j-core-version}-src.bin.sha256]
84+
85+
| Signature
86+
| {dist-url}/apache-log4j-{log4j-core-version}-bin.zip.asc[apache-log4j-{log4j-core-version}-src.bin.asc]
87+
88+
| PGP keys
89+
| https://downloads.apache.org/logging/KEYS[KEYS]
90+
|===
91+
92+
[NOTE]
93+
====
94+
The authenticity of the Apache Log4j binary release is independently verified by the
95+
https://github.com/jvm-repo-rebuild/reproducible-central[Reproducible Builds for Maven Central Repository]
96+
project.
97+
You can check the reproducibility status of the artifacts on their
98+
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.
99+
====
100+
101+
[#sbom]
102+
== Software Bill of Materials (SBOM)
103+
104+
Each Apache Log4j artifact is accompanied by a Software Bill of Materials in
105+
https://cyclonedx.org/[CycloneDX format].
106+
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.
107+
108+
See also {logging-services-url}/download.html#sbom[Apache Logging Services SBOMs].
109+
110+
[IMPORTANT]
111+
====
112+
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.
113+
These versions are used by our unit tests.
114+
115+
The **effective** list of components included in an application containing Apache Log4j can only be determined by the producer of the application.
116+
====
24117
25118
[#older]
26119
== Older releases
27120
28121
Are you looking for old versions of Log4j?
29-
While we recommend to always use the latest version, you can find the older versions here:
122+
While we recommend always using the latest version, you can find the older versions here:
30123
31124
* {logging-services-url}/log4j/1.x/index.html[Log4j 1.x (End of Life, Java 1.4)]
32125
* {logging-services-url}/log4j/2.3.x/index.html[Log4j 2.3.x (Java 6)]

src/site/antora/modules/ROOT/pages/manual/api.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -282,14 +282,6 @@ include::example$manual/api/LoggerNameTest.java[tag=thread-context3,indent=0]
282282
<4> Popping the last pushed property from the thread context stack
283283
<5> Clearing the thread context (for both stack and map!)
284284
285-
[WARNING]
286-
====
287-
**Thread Context is mostly superseded by Scoped Context**, which, unlike Thread Context,
288-
289-
* is safe to use in servlet applications
290-
* can store any `Object`-typed value
291-
====
292-
293285
xref:manual/thread-context.adoc[Read more on Thread Context]...
294286
295287
[#messages]

0 commit comments

Comments
 (0)