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/11/20 09:12:01 UTC
(logging-log4j-site) 01/02: Add `log4j-tools` version `0.6.0` site
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/logging-log4j-site.git
commit c14e5da1b6d171df5f98ef6e174cddd2a3930989
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Mon Nov 13 15:11:33 2023 +0100
Add `log4j-tools` version `0.6.0` site
---
tools/0.x/index.html | 119 +++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 102 insertions(+), 17 deletions(-)
diff --git a/tools/0.x/index.html b/tools/0.x/index.html
index 810f5eb1a..bdd36ed74 100644
--- a/tools/0.x/index.html
+++ b/tools/0.x/index.html
@@ -552,11 +552,17 @@ table.CodeRay td.code{padding:0 0 0 .75em}
</ul>
</li>
<li><a href="#development">Development</a></li>
-<li><a href="#distribution">Distribution</a></li>
+<li><a href="#distribution">Distribution</a>
+<ul class="sectlevel2">
+<li><a href="#maven-bom">Maven Bill of Materials (BOM)</a></li>
+<li><a href="#cyclonedx-sbom">CycloneDX Software Bill of Materials (SBOM)</a></li>
+</ul>
+</li>
<li><a href="#support">Support</a></li>
<li><a href="#security">Security</a></li>
<li><a href="#release-notes">Release Notes</a>
<ul class="sectlevel2">
+<li><a href="#release-notes-0-6-0">0.6.0</a></li>
<li><a href="#release-notes-0-5-0">0.5.0</a></li>
<li><a href="#release-notes-0-4-0">0.4.0</a></li>
<li><a href="#release-notes-0-3-0">0.3.0</a></li>
@@ -594,7 +600,7 @@ It is designed for Apache Log4j, but can be used for any Java project.</p>
<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
<span class="tag"><groupId></span>org.apache.logging.log4j<span class="tag"></groupId></span>
<span class="tag"><artifactId></span>log4j-changelog<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.5.0<span class="tag"></version></span>
+ <span class="tag"><version></span>0.6.0<span class="tag"></version></span>
<span class="tag"></dependency></span></code></pre>
</div>
</div>
@@ -1021,7 +1027,7 @@ This allows one to run <code>ChangelogReleaser</code> multiple times, e.g., to i
<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><plugin></span>
<span class="tag"><groupId></span>org.apache.logging.log4j<span class="tag"></groupId></span>
<span class="tag"><artifactId></span>log4j-changelog-maven-plugin<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.5.0<span class="tag"></version></span>
+ <span class="tag"><version></span>0.6.0<span class="tag"></version></span>
<span class="tag"></plugin></span></code></pre>
</div>
</div>
@@ -1059,7 +1065,7 @@ These are generally used to generate the index page referencing to release notes
<span class="tag"><plugin></span>
<span class="tag"><groupId></span>org.apache.logging.log4j<span class="tag"></groupId></span>
<span class="tag"><artifactId></span>log4j-changelog-maven-plugin<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.5.0<span class="tag"></version></span>
+ <span class="tag"><version></span>0.6.0<span class="tag"></version></span>
<span class="tag"><inherited></span>false<span class="tag"></inherited></span>
<span class="tag"><configuration></span>
<span class="tag"><indexTemplates></span>
@@ -1229,6 +1235,41 @@ python -m http.server -d target/site</code></pre>
<div class="paragraph">
<p>See <a href="#release-instructions">the release instructions</a> for details.</p>
</div>
+<div class="sect2">
+<h3 id="maven-bom">Maven Bill of Materials (BOM)</h3>
+<div class="paragraph">
+<p>To keep your Log4j Tools module versions aligned, a <a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms">Maven Bill of Materials (BOM) POM</a> is provided for your convenience.</p>
+</div>
+<div class="paragraph">
+<p>To use this with Maven, add the dependency listed below to your <code>pom.xml</code> file.
+Note that the <code><dependencyManagement></code> nesting and the <code><scope>import</scope></code> instruction.
+This will <em>import</em> all modules bundled with the associated Log4j release to your <code>dependencyManagement</code>.
+As a result, you don’t have to specify versions of the imported modules (<code>log4j-changelog</code>, etc.) while using them as a <code><dependency></code>.</p>
+</div>
+<div class="listingblock">
+<div class="title"><code>pom.xml</code> snippet importing <code>log4j-tools-bom</code></div>
+<div class="content">
+<pre class="CodeRay highlight"><code><dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-tools-bom</artifactId>
+ <version>0.6.0</version>
+ <scope>import</scope>
+ <type>pom</type>
+ </dependency>
+ </dependencies>
+</dependencyManagement></code></pre>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="cyclonedx-sbom">CycloneDX Software Bill of Materials (SBOM)</h3>
+<div class="paragraph">
+<p>Starting with version <code>0.6.0</code>, Log4j Tools distributes <a href="https://cyclonedx.org/capabilities/sbom/">CyclenoDX Software Bill of Materials (SBOM)</a> along with each deployed artifact.
+This is streamlined by <code>logging-parent</code>, see <a href="https://logging.apache.org/logging-parent/latest/#cyclonedx-sbom">its website</a> for details.</p>
+</div>
+</div>
</div>
</div>
<div class="sect1">
@@ -1254,12 +1295,12 @@ See <a href="https://logging.apache.org/log4j/2.x/security.html">the Log4j Secur
<h2 id="release-notes">Release Notes</h2>
<div class="sectionbody">
<div class="sect2">
-<h3 id="release-notes-0-5-0">0.5.0</h3>
+<h3 id="release-notes-0-6-0">0.6.0</h3>
<div class="dlist">
<dl>
<dt class="hdlist1">Release date</dt>
<dd>
-<p>2023-10-03</p>
+<p>2023-11-13</p>
</dd>
</dl>
</div>
@@ -1271,6 +1312,50 @@ See <a href="https://logging.apache.org/log4j/2.x/security.html">the Log4j Secur
<div class="ulist">
<ul>
<li>
+<p>Started generating CycloneDX SBOM with the recent update of <code>logging-parent</code> to version <code>10.3.0</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_changed">Changed</h4>
+<div class="ulist">
+<ul>
+<li>
+<p>Update <code>org.apache.logging:logging-parent</code> to version <code>10.3.0</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_fixed">Fixed</h4>
+<div class="ulist">
+<ul>
+<li>
+<p><code>log4j-tools-bom</code> was broken due to removed <code>parent</code> during flattening. This is automatically fixed by the recent <code>logging-parent</code> version <code>10.3.0</code> update.</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-0-5-0">0.5.0</h3>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-09-29</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains various bug fixes and improvements.</p>
+</div>
+<div class="sect3">
+<h4 id="_added_2">Added</h4>
+<div class="ulist">
+<ul>
+<li>
<p>Added OSGi and JPMS support</p>
</li>
<li>
@@ -1280,7 +1365,7 @@ See <a href="https://logging.apache.org/log4j/2.x/security.html">the Log4j Secur
</div>
</div>
<div class="sect3">
-<h4 id="_changed">Changed</h4>
+<h4 id="_changed_2">Changed</h4>
<div class="ulist">
<ul>
<li>
@@ -1314,7 +1399,7 @@ See <a href="https://logging.apache.org/log4j/2.x/security.html">the Log4j Secur
Most importantly, this marks the first release where the project uses itself to generate release notes!</p>
</div>
<div class="sect3">
-<h4 id="_added_2">Added</h4>
+<h4 id="_added_3">Added</h4>
<div class="ulist">
<ul>
<li>
@@ -1324,7 +1409,7 @@ Most importantly, this marks the first release where the project uses itself to
</div>
</div>
<div class="sect3">
-<h4 id="_changed_2">Changed</h4>
+<h4 id="_changed_3">Changed</h4>
<div class="ulist">
<ul>
<li>
@@ -1337,7 +1422,7 @@ Most importantly, this marks the first release where the project uses itself to
</div>
</div>
<div class="sect3">
-<h4 id="_fixed">Fixed</h4>
+<h4 id="_fixed_2">Fixed</h4>
<div class="ulist">
<ul>
<li>
@@ -1361,7 +1446,7 @@ Most importantly, this marks the first release where the project uses itself to
<p>This minor release contains various bug fixes and improvements.</p>
</div>
<div class="sect3">
-<h4 id="_added_3">Added</h4>
+<h4 id="_added_4">Added</h4>
<div class="ulist">
<ul>
<li>
@@ -1374,7 +1459,7 @@ Most importantly, this marks the first release where the project uses itself to
</div>
</div>
<div class="sect3">
-<h4 id="_changed_3">Changed</h4>
+<h4 id="_changed_4">Changed</h4>
<div class="ulist">
<ul>
<li>
@@ -1398,7 +1483,7 @@ Most importantly, this marks the first release where the project uses itself to
<p>This minor release contains various bug fixes and improvements.</p>
</div>
<div class="sect3">
-<h4 id="_added_4">Added</h4>
+<h4 id="_added_5">Added</h4>
<div class="ulist">
<ul>
<li>
@@ -1411,7 +1496,7 @@ Most importantly, this marks the first release where the project uses itself to
</div>
</div>
<div class="sect3">
-<h4 id="_changed_4">Changed</h4>
+<h4 id="_changed_5">Changed</h4>
<div class="ulist">
<ul>
<li>
@@ -1431,7 +1516,7 @@ Most importantly, this marks the first release where the project uses itself to
</div>
</div>
<div class="sect3">
-<h4 id="_fixed_2">Fixed</h4>
+<h4 id="_fixed_3">Fixed</h4>
<div class="ulist">
<ul>
<li>
@@ -1458,7 +1543,7 @@ Most importantly, this marks the first release where the project uses itself to
<p>This is the first release, aimed to assist [the Apache Log4j 2](<a href="http://logging.apache.org/log4j/2.x/" class="bare">http://logging.apache.org/log4j/2.x/</a>) on generating release notes.</p>
</div>
<div class="sect3">
-<h4 id="_added_5">Added</h4>
+<h4 id="_added_6">Added</h4>
<div class="ulist">
<ul>
<li>
@@ -1497,7 +1582,7 @@ See the License for the specific language governing permissions and limitations
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2023-10-03 07:48:27 UTC
+Last updated 2023-11-13 11:23:12 UTC
</div>
</div>
</body>