This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch release/11.0.0-site-stg-out
in repository https://gitbox.apache.org/repos/asf/logging-parent.git
The following commit(s) were added to refs/heads/release/11.0.0-site-stg-out by
this push:
new 5493b64 Add website content generated from
`ce75abf99cb670354f6048c8068e502a1ff9a1e1`
5493b64 is described below
commit 5493b649c97b6e49bd8d4d9ba484f1e30776ac02
Author: ASF Logging Services RM <[email protected]>
AuthorDate: Mon Apr 15 10:53:38 2024 +0000
Add website content generated from
`ce75abf99cb670354f6048c8068e502a1ff9a1e1`
---
404.html | 82 ++++
README.txt | 1 -
_/css/site.css | 3 +
_/css/vendor/tabs.css | 110 +++++
_/font/roboto-cyrillic-400-italic.woff2 | Bin 0 -> 10292 bytes
_/font/roboto-cyrillic-400-normal.woff2 | Bin 0 -> 9628 bytes
_/font/roboto-cyrillic-500-italic.woff2 | Bin 0 -> 10640 bytes
_/font/roboto-cyrillic-500-normal.woff2 | Bin 0 -> 9840 bytes
_/font/roboto-latin-400-italic.woff | Bin 0 -> 22048 bytes
_/font/roboto-latin-400-italic.woff2 | Bin 0 -> 17368 bytes
_/font/roboto-latin-400-normal.woff | Bin 0 -> 20344 bytes
_/font/roboto-latin-400-normal.woff2 | Bin 0 -> 15744 bytes
_/font/roboto-latin-500-italic.woff | Bin 0 -> 22092 bytes
_/font/roboto-latin-500-italic.woff2 | Bin 0 -> 17336 bytes
_/font/roboto-latin-500-normal.woff | Bin 0 -> 20544 bytes
_/font/roboto-latin-500-normal.woff2 | Bin 0 -> 15920 bytes
_/font/roboto-mono-latin-400-normal.woff | Bin 0 -> 15160 bytes
_/font/roboto-mono-latin-400-normal.woff2 | Bin 0 -> 12312 bytes
_/font/roboto-mono-latin-500-normal.woff | Bin 0 -> 15364 bytes
_/font/roboto-mono-latin-500-normal.woff2 | Bin 0 -> 12532 bytes
_/img/back.svg | 1 +
_/img/caret.svg | 1 +
_/img/chevron.svg | 1 +
_/img/home-o.svg | 1 +
_/img/home.svg | 1 +
_/img/menu.svg | 1 +
_/img/octicons-16.svg | 1 +
_/js/site.js | 6 +
_/js/vendor/highlight.js | 1 +
_/js/vendor/tabs.js | 127 +++++
features.html | 238 +++++++++
index.html | 191 ++++++++
release-instructions-project.html | 529 ++++++++++++++++++++
release-instructions-xml-schema.html | 248 ++++++++++
release-notes.html | 771 ++++++++++++++++++++++++++++++
sitemap.xml | 27 ++
usage.html | 341 +++++++++++++
37 files changed, 2681 insertions(+), 1 deletion(-)
diff --git a/404.html b/404.html
new file mode 100644
index 0000000..1527069
--- /dev/null
+++ b/404.html
@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>Page Not Found :: Apache Logging Parent</title>
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="/logging-parent/_/css/site.css">
+<link rel="icon" href="/logging-parent/_/../_images/favicon.ico"
type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="/logging-parent/_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="status-404">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container">
+ <aside class="nav">
+ <div class="panels">
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="/logging-parent/index.html" class="home-link"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules//pages/">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<article class="doc">
+<h1 class="page">Page Not Found</h1>
+<div class="paragraph">
+<p>The page you’re looking for does not exist. It may have been moved.
You can return to the <a href="/index.html">start page</a>, or follow one of
the links in the navigation to the left.</p>
+</div>
+<div class="paragraph">
+<p>If you arrived on this page by clicking on a link, please notify the owner
of the site that the link is broken.
+If you typed the URL of this page manually, please double check that you
entered the address correctly.</p>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="/logging-parent/_/js/site.js"
data-ui-root-path="/logging-parent/_"></script>
+<script async src="/logging-parent/_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="/logging-parent/_/js/vendor/tabs.js"></script>
+ </body>
+</html>
diff --git a/README.txt b/README.txt
deleted file mode 100644
index a4d51e4..0000000
--- a/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Content for initializing an orphan branch for the website to be generated from
`ce75abf99cb670354f6048c8068e502a1ff9a1e1`
diff --git a/_/css/site.css b/_/css/site.css
new file mode 100644
index 0000000..e7b43c5
--- /dev/null
+++ b/_/css/site.css
@@ -0,0 +1,3 @@
+@font-face{font-family:Roboto;font-style:normal;font-weight:400;src:url(../font/roboto-latin-400-normal.woff2)
format("woff2"),url(../font/roboto-latin-400-normal.woff)
format("woff");unicode-range:U+00??,U+0131,U+0152-0153,U+02bb-02bc,U+02c6,U+02da,U+02dc,U+2000-206f,U+2074,U+20ac,U+2122,U+2191,U+2193,U+2212,U+2215,U+feff,U+fffd}@font-face{font-family:Roboto;font-style:normal;font-weight:400;src:url(../font/roboto-cyrillic-400-normal.woff2)
format("woff2");unicode-range:U+0301,U+0400-04 [...]
+
+/*! Adapted from the GitHub style by Vasily Polovnyov <[email protected]>
*/.hljs-comment,.hljs-quote{color:#998;font-style:italic}.hljs-keyword,.hljs-selector-tag,.hljs-subst{color:#333;font-weight:600}.hljs-literal,.hljs-number,.hljs-tag
.hljs-attr,.hljs-template-variable,.hljs-variable{color:teal}.hljs-doctag,.hljs-string{color:#d14}.hljs-section,.hljs-selector-id,.hljs-title{color:#900;font-weight:600}.hljs-subst{font-weight:400}.hljs-class
.hljs-title,.hljs-type{color:#458;font-wei [...]
\ No newline at end of file
diff --git a/_/css/vendor/tabs.css b/_/css/vendor/tabs.css
new file mode 100644
index 0000000..00771c4
--- /dev/null
+++ b/_/css/vendor/tabs.css
@@ -0,0 +1,110 @@
+/*! Asciidoctor Tabs | Copyright (c) 2018-present Dan Allen | MIT License */
+.tabs {
+ margin-bottom: 1.25em;
+}
+
+.tablist > ul {
+ display: flex;
+ flex-wrap: wrap;
+ list-style: none;
+ margin: 0;
+ padding: 0;
+}
+
+.tablist > ul li {
+ align-items: center;
+ background-color: #fff;
+ cursor: pointer;
+ display: flex;
+ font-weight: bold;
+ line-height: 1.5;
+ padding: 0.25em 1em;
+ position: relative;
+}
+
+.tablist > ul li:focus-visible {
+ outline: none;
+}
+
+.tablist.ulist,
+.tablist.ulist > ul li {
+ margin: 0;
+}
+
+.tablist.ulist > ul li + li {
+ margin-left: 0.25em;
+}
+
+.tabs .tablist li::after {
+ content: "";
+ display: block;
+ height: 1px;
+ position: absolute;
+ bottom: -1px;
+ left: 0;
+ right: 0;
+}
+
+.tabs.is-loading .tablist li:not(:first-child),
+.tabs:not(.is-loading) .tablist li:not(.is-selected) {
+ background-color: #f5f5f5;
+}
+
+.tabs.is-loading .tablist li:first-child::after,
+.tabs:not(.is-loading) .tablist li.is-selected::after {
+ background-color: #fff;
+}
+
+/*
+.tabs:not(.is-loading) .tablist li,
+.tabs:not(.is-loading) .tablist li::after {
+ transition: background-color 200ms ease-in-out;
+}
+*/
+
+.tablist > ul p {
+ line-height: inherit;
+ margin: 0;
+}
+
+.tabpanel {
+ background-color: #fff;
+ padding: 1.25em;
+}
+
+.tablist > ul li,
+.tabpanel {
+ border: 1px solid #dcdcdc;
+}
+
+.tablist > ul li {
+ border-bottom: 0;
+}
+
+.tabs.is-loading .tabpanel + .tabpanel,
+.tabs:not(.is-loading) .tabpanel.is-hidden {
+ display: none;
+}
+
+.tabpanel > :first-child {
+ margin-top: 0;
+}
+
+/* #content is a signature of the Asciidoctor standalone HTML output */
+#content .tabpanel > :last-child,
+#content .tabpanel > :last-child > :last-child,
+#content .tabpanel > :last-child > :last-child > li:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+.tablecontainer {
+ overflow-x: auto;
+}
+
+#content .tablecontainer {
+ margin-bottom: 1.25em;
+}
+
+#content .tablecontainer > table.tableblock {
+ margin-bottom: 0;
+}
diff --git a/_/font/roboto-cyrillic-400-italic.woff2
b/_/font/roboto-cyrillic-400-italic.woff2
new file mode 100644
index 0000000..dd587a2
Binary files /dev/null and b/_/font/roboto-cyrillic-400-italic.woff2 differ
diff --git a/_/font/roboto-cyrillic-400-normal.woff2
b/_/font/roboto-cyrillic-400-normal.woff2
new file mode 100644
index 0000000..47da362
Binary files /dev/null and b/_/font/roboto-cyrillic-400-normal.woff2 differ
diff --git a/_/font/roboto-cyrillic-500-italic.woff2
b/_/font/roboto-cyrillic-500-italic.woff2
new file mode 100644
index 0000000..cbe564b
Binary files /dev/null and b/_/font/roboto-cyrillic-500-italic.woff2 differ
diff --git a/_/font/roboto-cyrillic-500-normal.woff2
b/_/font/roboto-cyrillic-500-normal.woff2
new file mode 100644
index 0000000..cb5834f
Binary files /dev/null and b/_/font/roboto-cyrillic-500-normal.woff2 differ
diff --git a/_/font/roboto-latin-400-italic.woff
b/_/font/roboto-latin-400-italic.woff
new file mode 100644
index 0000000..ebee16b
Binary files /dev/null and b/_/font/roboto-latin-400-italic.woff differ
diff --git a/_/font/roboto-latin-400-italic.woff2
b/_/font/roboto-latin-400-italic.woff2
new file mode 100644
index 0000000..e1b7a79
Binary files /dev/null and b/_/font/roboto-latin-400-italic.woff2 differ
diff --git a/_/font/roboto-latin-400-normal.woff
b/_/font/roboto-latin-400-normal.woff
new file mode 100644
index 0000000..9eaa94f
Binary files /dev/null and b/_/font/roboto-latin-400-normal.woff differ
diff --git a/_/font/roboto-latin-400-normal.woff2
b/_/font/roboto-latin-400-normal.woff2
new file mode 100644
index 0000000..020729e
Binary files /dev/null and b/_/font/roboto-latin-400-normal.woff2 differ
diff --git a/_/font/roboto-latin-500-italic.woff
b/_/font/roboto-latin-500-italic.woff
new file mode 100644
index 0000000..b6ad1c5
Binary files /dev/null and b/_/font/roboto-latin-500-italic.woff differ
diff --git a/_/font/roboto-latin-500-italic.woff2
b/_/font/roboto-latin-500-italic.woff2
new file mode 100644
index 0000000..ae1933f
Binary files /dev/null and b/_/font/roboto-latin-500-italic.woff2 differ
diff --git a/_/font/roboto-latin-500-normal.woff
b/_/font/roboto-latin-500-normal.woff
new file mode 100644
index 0000000..d39bb52
Binary files /dev/null and b/_/font/roboto-latin-500-normal.woff differ
diff --git a/_/font/roboto-latin-500-normal.woff2
b/_/font/roboto-latin-500-normal.woff2
new file mode 100644
index 0000000..29342a8
Binary files /dev/null and b/_/font/roboto-latin-500-normal.woff2 differ
diff --git a/_/font/roboto-mono-latin-400-normal.woff
b/_/font/roboto-mono-latin-400-normal.woff
new file mode 100644
index 0000000..be3eb4c
Binary files /dev/null and b/_/font/roboto-mono-latin-400-normal.woff differ
diff --git a/_/font/roboto-mono-latin-400-normal.woff2
b/_/font/roboto-mono-latin-400-normal.woff2
new file mode 100644
index 0000000..f8894ba
Binary files /dev/null and b/_/font/roboto-mono-latin-400-normal.woff2 differ
diff --git a/_/font/roboto-mono-latin-500-normal.woff
b/_/font/roboto-mono-latin-500-normal.woff
new file mode 100644
index 0000000..43ca6a1
Binary files /dev/null and b/_/font/roboto-mono-latin-500-normal.woff differ
diff --git a/_/font/roboto-mono-latin-500-normal.woff2
b/_/font/roboto-mono-latin-500-normal.woff2
new file mode 100644
index 0000000..b4f2bf8
Binary files /dev/null and b/_/font/roboto-mono-latin-500-normal.woff2 differ
diff --git a/_/img/back.svg b/_/img/back.svg
new file mode 100644
index 0000000..bf7d30e
--- /dev/null
+++ b/_/img/back.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" viewBox="0 0
100 100"><path d="M50.001 9.9L9.9 50 50
90.1l5.656-5.655-30.435-30.442H90.1v-8.006H25.222l30.435-30.44z"/></svg>
\ No newline at end of file
diff --git a/_/img/caret.svg b/_/img/caret.svg
new file mode 100644
index 0000000..1af41bc
--- /dev/null
+++ b/_/img/caret.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30
30"><path d="M10.187 3l14 12-14 12z" fill="#c1c1c1" stroke="#c1c1c1"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/></svg>
\ No newline at end of file
diff --git a/_/img/chevron.svg b/_/img/chevron.svg
new file mode 100644
index 0000000..40e962a
--- /dev/null
+++ b/_/img/chevron.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30
30"><path d="M3.67 6.59L1.455 8.615 15 23.375l13.545-14.76L26.33 6.59 15
18.76z" fill="#5d5d5d"/></svg>
\ No newline at end of file
diff --git a/_/img/home-o.svg b/_/img/home-o.svg
new file mode 100644
index 0000000..95d193b
--- /dev/null
+++ b/_/img/home-o.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><g fill="none"
stroke="#222" stroke-width="4"><path d="M50.02 13.576l-28.58 25.54-.02
47.345h21.506l.025-25.166H57.05l.025
25.166H78.62l.02-47.31-28.62-25.575z"/><path d="M63.815
25.904v-9.217h8.657V33.64zM21.439 39.116l-9.982 8.92m77.125
0l-9.943-8.885"/></g></svg>
\ No newline at end of file
diff --git a/_/img/home.svg b/_/img/home.svg
new file mode 100644
index 0000000..4e96b35
--- /dev/null
+++ b/_/img/home.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><g stroke="#222"
stroke-width="4"><path d="M50.02 13.576l-28.58 25.54-.02
47.345h21.506l.025-25.166H57.05l.025 25.166H78.62l.02-47.31-28.62-25.575z"
fill="#222" fill-rule="evenodd"/><path d="M63.815 25.904v-9.217h8.657V33.64z"
fill="#222" fill-rule="evenodd"/><path d="M21.439 39.116l-9.982 8.92m77.125
0l-9.943-8.885" fill="none"/></g></svg>
\ No newline at end of file
diff --git a/_/img/menu.svg b/_/img/menu.svg
new file mode 100644
index 0000000..8b43b2e
--- /dev/null
+++ b/_/img/menu.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><path d="M35
19.772h55" fill="none" stroke="#222" stroke-width="8"
stroke-opacity=".941"/><path fill="#222" d="M10 12.272h15v15H10z"/><path d="M43
63.678h45" fill="none" stroke="#222" stroke-width="5"
stroke-opacity=".941"/><path fill="#222" d="M23 58.677h10v10H23z"/><path d="M43
82.727h45" fill="none" stroke="#222" stroke-width="5"
stroke-opacity=".941"/><path fill="#222" d="M23 77.727h10v10H23z"/><path d="M43
44.628h45" fill [...]
\ No newline at end of file
diff --git a/_/img/octicons-16.svg b/_/img/octicons-16.svg
new file mode 100644
index 0000000..c221510
--- /dev/null
+++ b/_/img/octicons-16.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><desc>Octicons
v11.2.0 by GitHub - https://primer.style/octicons/ - License: MIT</desc><symbol
id="icon-clippy" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M5.75
1a.75.75 0 00-.75.75v3c0 .414.336.75.75.75h4.5a.75.75 0 00.75-.75v-3a.75.75 0
00-.75-.75h-4.5zm.75 3V2.5h3V4h-3zm-2.874-.467a.75.75 0 00-.752-1.298A1.75 1.75
0 002 3.75v9.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 13.25v-9.5a1.75
1.75 0 00-.874-1.515.75.75 0 [...]
\ No newline at end of file
diff --git a/_/js/site.js b/_/js/site.js
new file mode 100644
index 0000000..f02ada9
--- /dev/null
+++ b/_/js/site.js
@@ -0,0 +1,6 @@
+!function(){"use strict";var
i,c,e,o,t,s,r,l=/^sect(\d)$/,a=document.querySelector(".nav-container");function
n(){var
e,t,n=window.location.hash;if(n&&(n.indexOf("%")&&(n=decodeURIComponent(n)),!(e=o.querySelector('.nav-link[href="'+n+'"]')))){n=document.getElementById(n.slice(1));if(n)for(var
i=n,a=document.querySelector("article.doc");(i=i.parentNode)&&i!==a;){var
c=i.id;if((c=c||(c=l.test(i.className))&&(i.firstElementChild||{}).id)&&(e=o.querySelector('.nav-link[href="#'+c+'"]')))bre
[...]
+!function(){"use strict";var
e=document.querySelector("aside.toc.sidebar");if(e){if(document.querySelector("body.-toc"))return
e.parentNode.removeChild(e);var
t=parseInt(e.dataset.levels||2,10);if(!(t<0)){var
o="article.doc",d=document.querySelector(o);if(d){for(var
n=[],i=0;i<=t;i++){var r=[o];if(i){for(var
c=1;c<=i;c++)r.push((2===c?".sectionbody>":"")+".sect"+c);r.push("h"+(i+1)+"[id]"+(1<i?":not(.discrete)":""))}else
r.push("h1[id].sect0");n.push(r.join(">"))}m=n.join(","),f=d.parent [...]
+!function(){"use strict";var
n,o,i=document.querySelector("article.doc");function c(e){return
e&&(~e.indexOf("%")?decodeURIComponent(e):e).slice(1)}function
r(e){if(e){if(e.altKey||e.ctrlKey)return;window.location.hash="#"+this.id,e.preventDefault()}var
t=function e(t,n){return
i.contains(t)?e(t.offsetParent,t.offsetTop+n):n}(this,0)-n.getBoundingClientRect().bottom;!1===e&&o?window.scrollTo({left:0,top:t,behavior:"instant"}):window.scrollTo(0,t)}i&&(n=document.querySelector(".toolbar"),
[...]
+!function(){"use strict";var t,e=document.querySelector(".page-versions
.version-menu-toggle");e&&(t=document.querySelector(".page-versions"),e.addEventListener("click",function(e){t.classList.toggle("is-active"),e.stopPropagation()}),document.documentElement.addEventListener("click",function(){t.classList.remove("is-active")}))}();
+!function(){"use strict";var
i=document.querySelector(".navbar-burger");i&&i.addEventListener("click",function(t){t.stopPropagation(),document.documentElement.classList.toggle("is-clipped--navbar"),i.setAttribute("aria-expanded",this.classList.toggle("is-active"));t=document.getElementById(this.getAttribute("aria-controls")||this.dataset.target);{var
e;t.classList.toggle("is-active")&&(t.style.maxHeight="",e=window.innerHeight-Math.round(t.getBoundingClientRect().top),parseInt(window.get
[...]
+!function(){"use strict";var o=/^\$ (\S[^\\\n]*(\\\n(?!\$
)[^\\\n]*)*)(?=\n|$)/gm,s=/( ) *\\\n *|\\\n( ?) */g,l=/
+$/gm,e=(document.getElementById("site-script")||{dataset:{}}).dataset,d=window.navigator.clipboard,r=e.svgAs,p=(null==e.uiRootPath?window:e).uiRootPath||".";[].slice.call(document.querySelectorAll(".doc
pre.highlight, .doc .literalblock pre")).forEach(function(e){var
t,n,a,c;if(e.classList.contains("highlight"))(i=(t=e.querySelector("code")).dataset.lang)&&"console"!==i&&((a
[...]
\ No newline at end of file
diff --git a/_/js/vendor/highlight.js b/_/js/vendor/highlight.js
new file mode 100644
index 0000000..c617244
--- /dev/null
+++ b/_/js/vendor/highlight.js
@@ -0,0 +1 @@
+!function(){function
e(e){return{aliases:["adoc"],contains:[e.COMMENT("^/{4,}\\n","\\n/{4,}$",{relevance:10}),e.COMMENT("^//","$",{relevance:0}),{className:"title",begin:"^\\.\\w.*$"},{begin:"^[=\\*]{4,}\\n",end:"\\n^[=\\*]{4,}$",relevance:10},{className:"section",relevance:10,variants:[{begin:"^(={1,5})
.+?(
\\1)?$"},{begin:"^[^\\[\\]\\n]+?\\n[=\\-~\\^\\+]{2,}$"}]},{className:"meta",begin:"^:.+?:",end:"\\s",excludeEnd:!0,relevance:10},{className:"meta",begin:"^\\[.+?\\]$",relevance:0},{
[...]
\ No newline at end of file
diff --git a/_/js/vendor/tabs.js b/_/js/vendor/tabs.js
new file mode 100644
index 0000000..f8966c0
--- /dev/null
+++ b/_/js/vendor/tabs.js
@@ -0,0 +1,127 @@
+;(function () { /*! Asciidoctor Tabs | Copyright (c) 2018-present Dan Allen |
MIT License */
+ 'use strict'
+
+ var config = (document.currentScript || {}).dataset || {}
+ var forEach = Array.prototype.forEach
+
+ init(document.querySelectorAll('.tabs'))
+
+ function init (tabsBlocks) {
+ if (!tabsBlocks.length) return
+ forEach.call(tabsBlocks, function (tabs) {
+ var syncIds = tabs.classList.contains('is-sync') ? {} : undefined
+ var tablist = tabs.querySelector('.tablist ul')
+ tablist.setAttribute('role', 'tablist')
+ var start
+ forEach.call(tablist.querySelectorAll('li'), function (tab, idx) {
+ tab.tabIndex = -1
+ tab.setAttribute('role', tab.classList.add('tab') || 'tab')
+ var id, anchor, syncId
+ if (!(id = tab.id) && (anchor = tab.querySelector('a[id]'))) {
+ id = tab.id = anchor.parentNode.removeChild(anchor).id
+ }
+ var panel = id && tabs.querySelector('.tabpanel[aria-labelledby~="' +
id + '"]')
+ if (!panel) return idx ? undefined : toggleSelected(tab, true) //
invalid state
+ syncIds && (((syncId = tab.textContent.trim()) in syncIds) ? (syncId =
undefined) : true) &&
+ (syncIds[(tab.dataset.syncId = syncId)] = tab)
+ idx || (syncIds && (start = { tab: tab, panel: panel })) ?
toggleHidden(panel, true) : toggleSelected(tab, true)
+ tab.setAttribute('aria-controls', panel.id)
+ panel.setAttribute('role', 'tabpanel')
+ var onClick = syncId === undefined ? activateTab : activateTabSync
+ tab.addEventListener('click', onClick.bind({ tabs: tabs, tab: tab,
panel: panel }))
+ })
+ if (!tabs.closest('.tabpanel')) {
+ forEach.call(tabs.querySelectorAll('.tabpanel table.tableblock'),
function (table) {
+ var container = Object.assign(document.createElement('div'), {
className: 'tablecontainer' })
+ table.parentNode.insertBefore(container, table).appendChild(table)
+ })
+ }
+ if (start) {
+ var syncGroupId
+ for (var i = 0, lst = tabs.classList, len = lst.length, className; i
!== len; i++) {
+ if (!(className = lst.item(i)).startsWith('data-sync-group-id='))
continue
+ tabs.dataset.syncGroupId = syncGroupId = lst.remove(className) ||
className.slice(19).replace(/\u00a0/g, ' ')
+ break
+ }
+ if (syncGroupId === undefined) tabs.dataset.syncGroupId = syncGroupId
= Object.keys(syncIds).sort().join('|')
+ var preferredSyncId = 'syncStorageKey' in config &&
+ window[(config.syncStorageScope || 'local') +
'Storage'].getItem(config.syncStorageKey + '-' + syncGroupId)
+ var tab = preferredSyncId && syncIds[preferredSyncId]
+ tab && Object.assign(start, { tab: tab, panel:
document.getElementById(tab.getAttribute('aria-controls')) })
+ toggleSelected(start.tab, true) || toggleHidden(start.panel, false)
+ }
+ })
+ onHashChange()
+ toggleClassOnEach(tabsBlocks, 'is-loading', 'remove')
+ window.setTimeout(toggleClassOnEach.bind(null, tabsBlocks, 'is-loaded',
'add'), 0)
+ window.addEventListener('hashchange', onHashChange)
+ }
+
+ function activateTab (e) {
+ var tab = this.tab
+ var tabs = this.tabs || (this.tabs = tab.closest('.tabs'))
+ var panel = this.panel || (this.panel =
document.getElementById(tab.getAttribute('aria-controls')))
+ querySelectorWithSiblings(tabs, '.tablist .tab', 'tab').forEach(function
(el) {
+ toggleSelected(el, el === tab)
+ })
+ querySelectorWithSiblings(tabs, '.tabpanel', 'tabpanel').forEach(function
(el) {
+ toggleHidden(el, el !== panel)
+ })
+ if (!this.isSync && 'syncStorageKey' in config && 'syncGroupId' in
tabs.dataset) {
+ var storageKey = config.syncStorageKey + '-' + tabs.dataset.syncGroupId
+ window[(config.syncStorageScope || 'local') +
'Storage'].setItem(storageKey, tab.dataset.syncId)
+ }
+ if (!e) return
+ var loc = window.location
+ var hashIdx = loc.hash ? loc.href.indexOf('#') : -1
+ if (~hashIdx) window.history.replaceState(null, '', loc.href.slice(0,
hashIdx))
+ e.preventDefault()
+ }
+
+ function activateTabSync (e) {
+ activateTab.call(this, e)
+ var thisTabs = this.tabs
+ var thisTab = this.tab
+ var initialY = thisTabs.getBoundingClientRect().y
+ forEach.call(document.querySelectorAll('.tabs'), function (tabs) {
+ if (tabs === thisTabs || tabs.dataset.syncGroupId !==
thisTabs.dataset.syncGroupId) return
+ querySelectorWithSiblings(tabs, '.tablist .tab', 'tab').forEach(function
(tab) {
+ if (tab.dataset.syncId === thisTab.dataset.syncId) activateTab.call({
tabs: tabs, tab: tab, isSync: true })
+ })
+ })
+ var shiftedBy = thisTabs.getBoundingClientRect().y - initialY
+ if (shiftedBy && (shiftedBy = Math.round(shiftedBy))) window.scrollBy({
top: shiftedBy, behavior: 'instant' })
+ }
+
+ function querySelectorWithSiblings (scope, selector, siblingClass) {
+ var el = scope.querySelector(selector)
+ if (!el) return []
+ var result = [el]
+ while ((el = el.nextElementSibling) &&
el.classList.contains(siblingClass)) result.push(el)
+ return result
+ }
+
+ function toggleClassOnEach (elements, className, method) {
+ forEach.call(elements, function (el) {
+ el.classList[method](className)
+ })
+ }
+
+ function toggleHidden (el, state) {
+ el.classList[(el.hidden = state) ? 'add' : 'remove']('is-hidden')
+ }
+
+ function toggleSelected (el, state) {
+ el.setAttribute('aria-selected', '' + state)
+ el.classList[state ? 'add' : 'remove']('is-selected')
+ el.tabIndex = state ? 0 : -1
+ }
+
+ function onHashChange () {
+ var id = window.location.hash.slice(1)
+ if (!id) return
+ var tab = document.getElementById(~id.indexOf('%') ?
decodeURIComponent(id) : id)
+ if (!(tab && tab.classList.contains('tab'))) return
+ 'syncId' in tab.dataset ? activateTabSync.call({ tab: tab }) :
activateTab.call({ tab: tab })
+ }
+})()
diff --git a/features.html b/features.html
new file mode 100644
index 0000000..c250957
--- /dev/null
+++ b/features.html
@@ -0,0 +1,238 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>Features :: Apache Logging Parent</title>
+ <link rel="canonical"
href="https://logging.apache.org/logging-parent/features.html">
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="./_/css/site.css">
+<link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="./_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="article">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container" data-component="ROOT" data-version="">
+ <aside class="nav">
+ <div class="panels">
+<div class="nav-panel-menu is-active" data-panel="menu">
+ <nav class="nav-menu">
+ <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all"
style="display: none"></button>
+ <h3 class="title"><a href="index.html">Home</a></h3>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item is-current-page" data-depth="1">
+ <a class="nav-link" href="features.html">Features</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="usage.html">Usage</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-notes.html">Release notes</a>
+ </li>
+</ul>
+ </li>
+ <li class="nav-item" data-depth="0">
+ <button class="nav-item-toggle"></button>
+ <span class="nav-text">Release instructions</span>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-project.html">For
projects</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-xml-schema.html">For XML
schemas</a>
+ </li>
+</ul>
+ </li>
+</ul>
+ </nav>
+</div>
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="index.html" class="home-link"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li><a href="features.html">Features</a></li>
+ </ul>
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules/ROOT/pages/features.adoc">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<aside class="toc sidebar" data-title="Contents" data-levels="2">
+ <div class="toc-menu"></div>
+</aside>
+<article class="doc">
+<h1 class="page">Features</h1>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>Logging Parent aims to deliver the following features.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="parent-pom"><a class="anchor" href="#parent-pom"></a>Parent POM</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The provided parent POM features the following conveniences:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="https://creadur.apache.org/rat"><code>apache-rat-plugin</code></a>
integration for license preamble verification</p>
+</li>
+<li>
+<p><a
href="https://github.com/apache/logging-log4j-tools/tree/main/log4j-changelog-maven-plugin"><code>log4j-changelog-maven-plugin</code></a>
integration for changelog and release note management</p>
+</li>
+<li>
+<p><a
href="https://maven.apache.org/enforcer/maven-enforcer-plugin/"><code>maven-enforcer-plugin</code></a>
checks</p>
+</li>
+<li>
+<p><a
href="https://github.com/diffplug/spotless/tree/main/plugin-maven"><code>spotless-maven-plugin</code></a>
integration for code formatting</p>
+</li>
+<li>
+<p><a
href="https://www.eclemma.org/jacoco/trunk/doc/maven.html"><code>jacoco-maven-plugin</code></a>
integration for test coverage analysis (optional <code>coverage</code>
profile)</p>
+</li>
+<li>
+<p><a
href="https://github.com/bndtools/bnd/blob/master/maven-plugins/bnd-maven-plugin/README.md"><code>bnd-maven-plugin</code></a>
integration for auto-generating OSGi and JPMS descriptors</p>
+</li>
+<li>
+<p><a
href="https://github.com/CycloneDX/cyclonedx-maven-plugin">cyclonedx-maven-plugin</a>
integration for auto-generating Software Bill of Materials (SBOM)</p>
+</li>
+<li>
+<p><a href="https://antora.org/">Antora</a>-based site generation</p>
+</li>
+</ul>
+</div>
+<div class="sect2">
+<h3 id="cyclonedx-sbom"><a class="anchor" href="#cyclonedx-sbom"></a>CycloneDX
Software Bill of Materials (SBOM)</h3>
+<div class="paragraph">
+<p>Logging Parent streamlines the generation of <a
href="https://cyclonedx.org/capabilities/vdr">CycloneDX Software Bill of
Materials (SBOM)</a> using <a
href="https://github.com/CycloneDX/cyclonedx-maven-plugin">cyclonedx-maven-plugin</a>.
+Plugin execution is configured and activated to generate SBOM files for each
module, including the root one.
+Generated SBOM files are attached as artifacts with <code>cyclonedx</code>
classifier and XML extensions, that is,
<code><artifactId>-<version>-cyclonedx.xml</code>.</p>
+</div>
+<div class="paragraph">
+<p>Produced SBOMs are enriched with <code>vulnerability-assertion</code>
references to a <a href="https://cyclonedx.org/capabilities/vdr">CycloneDX
Vulnerability Disclosure Report (VDR)</a> that Apache Logging Services uses for
all projects it maintains.
+This VDR is accessible through the following URL: <a
href="https://logging.apache.org/cyclonedx/vdr.xml"
class="bare">https://logging.apache.org/cyclonedx/vdr.xml</a></p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="reusable-workflows"><a class="anchor"
href="#reusable-workflows"></a>Reusable GitHub Actions workflows</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The provided reusable GitHub Actions workflows feature the following
conveniences:</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><code>build-reusable.yaml</code></dt>
+<dd>
+<div class="ulist">
+<ul>
+<li>
+<p>Compiles against Java 8 bytecode using the specified Java compiler
version</p>
+</li>
+<li>
+<p>Verifies reproducibility</p>
+</li>
+</ul>
+</div>
+</dd>
+<dt class="hdlist1"><code>deploy-site-reusable.yaml</code></dt>
+<dd>
+<div class="ulist">
+<ul>
+<li>
+<p>Builds and deploys the website</p>
+</li>
+</ul>
+</div>
+</dd>
+<dt class="hdlist1"><code>deploy-snapshot-reusable.yaml</code></dt>
+<dd>
+<div class="ulist">
+<ul>
+<li>
+<p>Deploys SNAPSHOT artifacts</p>
+</li>
+</ul>
+</div>
+</dd>
+<dt class="hdlist1"><code>deploy-release-reusable.yaml</code></dt>
+<dd>
+<div class="ulist">
+<ul>
+<li>
+<p>Deploys release artifacts</p>
+</li>
+<li>
+<p>Updates <code>revision</code> and
<code>project.build.outputTimestamp</code> Maven properties</p>
+</li>
+<li>
+<p>Generates the distribution ZIP containing Git-tracked sources, binary
attachments, <code>NOTICE.txt</code>, etc.</p>
+</li>
+<li>
+<p>Generates the release vote & announcement emails</p>
+</li>
+<li>
+<p>Uploads the distribution ZIP and emails to SVN</p>
+</li>
+</ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script>
+<script async src="./_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="./_/js/vendor/tabs.js"></script>
+ </body>
+</html>
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..cc58733
--- /dev/null
+++ b/index.html
@@ -0,0 +1,191 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>Logging Parent :: Apache Logging Parent</title>
+ <link rel="canonical"
href="https://logging.apache.org/logging-parent/index.html">
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="./_/css/site.css">
+<link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="./_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="article">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container" data-component="ROOT" data-version="">
+ <aside class="nav">
+ <div class="panels">
+<div class="nav-panel-menu is-active" data-panel="menu">
+ <nav class="nav-menu">
+ <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all"
style="display: none"></button>
+ <h3 class="title"><a href="index.html">Home</a></h3>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="features.html">Features</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="usage.html">Usage</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-notes.html">Release notes</a>
+ </li>
+</ul>
+ </li>
+ <li class="nav-item" data-depth="0">
+ <button class="nav-item-toggle"></button>
+ <span class="nav-text">Release instructions</span>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-project.html">For
projects</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-xml-schema.html">For XML
schemas</a>
+ </li>
+</ul>
+ </li>
+</ul>
+ </nav>
+</div>
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="index.html" class="home-link is-current"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li><a href="index.html">Logging Parent</a></li>
+ </ul>
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules/ROOT/pages/index.adoc">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<aside class="toc sidebar" data-title="Contents" data-levels="2">
+ <div class="toc-menu"></div>
+</aside>
+<article class="doc">
+<h1 class="page">Logging Parent</h1>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>Logging Parent is the parent project <strong>internally</strong> used in
Maven-based projects of <a href="https://logging.apache.org">the Apache Logging
Services</a>.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="development"><a class="anchor" href="#development"></a>Development</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Logging Parent uses <a
href="https://github.com/apache/logging-parent">GitHub</a> for source code
management.</p>
+</div>
+<div class="paragraph">
+<p>The project requires a Java compiler matching the <code>[17,18)</code>
range and targets Java <code>8</code>.</p>
+</div>
+<div class="paragraph">
+<p>You can build and verify sources using:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">./mvnw verify</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>You can build the website as follows:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">./mvnw site</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>This will generate the website to the <code>target/site</code> folder,
which you can view with a browser.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="distribution"><a class="anchor"
href="#distribution"></a>Distribution</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>In accordance with the Apache Software Foundation’s release <a
href="https://infra.apache.org/release-distribution.html">distribution
policy</a> and <a
href="https://infra.apache.org/release-publishing.html">creation process</a>,
project artifacts are <em>officially</em> accessible from the following
locations:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>ASF <a
href="https://repository.apache.org/content/repositories/releases">Release</a>
and <a
href="https://repository.apache.org/content/repositories/snapshots">snapshot</a>
repositories (mirrored to <a href="https://central.sonatype.dev/">the Maven
Central Repository</a>)</p>
+</li>
+<li>
+<p>ASF <a
href="https://downloads.apache.org/logging/logging-parent">Distribution
directory</a></p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="support"><a class="anchor" href="#support"></a>Support</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>This project is intended for internal usage only.
+You can use GitHub Issues for feature requests and bug reports – not questions!
+See <a href="https://logging.apache.org/support.html">the Logging Services
support policy</a> for details.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="security"><a class="anchor" href="#security"></a>Security</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Are you looking for the list of known security vulnerabilities?
+Have you encountered an unlisted security vulnerability or other unexpected
behaviour that has a security impact?
+Please refer to <a href="https://logging.apache.org/security/">the Logging
Services Security page</a></p>
+</div>
+</div>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script>
+<script async src="./_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="./_/js/vendor/tabs.js"></script>
+ </body>
+</html>
diff --git a/release-instructions-project.html
b/release-instructions-project.html
new file mode 100644
index 0000000..95fc79d
--- /dev/null
+++ b/release-instructions-project.html
@@ -0,0 +1,529 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>Project release instructions :: Apache Logging Parent</title>
+ <link rel="canonical"
href="https://logging.apache.org/logging-parent/release-instructions-project.html">
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="./_/css/site.css">
+<link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="./_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="article">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container" data-component="ROOT" data-version="">
+ <aside class="nav">
+ <div class="panels">
+<div class="nav-panel-menu is-active" data-panel="menu">
+ <nav class="nav-menu">
+ <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all"
style="display: none"></button>
+ <h3 class="title"><a href="index.html">Home</a></h3>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="features.html">Features</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="usage.html">Usage</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-notes.html">Release notes</a>
+ </li>
+</ul>
+ </li>
+ <li class="nav-item" data-depth="0">
+ <button class="nav-item-toggle"></button>
+ <span class="nav-text">Release instructions</span>
+<ul class="nav-list">
+ <li class="nav-item is-current-page" data-depth="1">
+ <a class="nav-link" href="release-instructions-project.html">For
projects</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-xml-schema.html">For XML
schemas</a>
+ </li>
+</ul>
+ </li>
+</ul>
+ </nav>
+</div>
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="index.html" class="home-link"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li>Release instructions</li>
+ <li><a href="release-instructions-project.html">For projects</a></li>
+ </ul>
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<aside class="toc sidebar" data-title="Contents" data-levels="2">
+ <div class="toc-menu"></div>
+</aside>
+<article class="doc">
+<h1 class="page">Project release instructions</h1>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>This section explains how to publish a new release of projects extending
from the <code>logging-parent</code> POM and using its reusable CI
workflows.</p>
+</div>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Shared instructions hardcode the following constants:</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Project ID</dt>
+<dd>
+<p><code>logging-parent</code></p>
+</dd>
+<dt class="hdlist1">Project version</dt>
+<dd>
+<p><code>7.8.0</code></p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p><strong>You must adapt these values for your project!</strong>
+For instance, project ID needs to be replaced with <code>log4j</code> for
Log4j, <code>log4j-kotlin</code> for Log4j Kotlin, etc.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="stage-release"><a class="anchor" href="#stage-release"></a>Stage the
release</h2>
+<div class="sectionbody">
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Create the release branch:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git fetch -p
+git checkout -B release/7.8.0 origin/main</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Prepare sources for the release:</p>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>Update the <code>revision</code> property in <code>pom.xml</code></p>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>If your project refers to its own version in the site sources, those need
to be updated too.
+For instance, <code>site-project.version</code> needs to be updated for
<code>logging-parent</code>.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Release the changelog:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">./mvnw -N -P changelog-release</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Edit the release notes (i.e.,
<code>src/changelog/7.8.0/.release-notes.adoc.ftl</code>)</p>
+</li>
+</ol>
+</div>
+</li>
+<li>
+<p>Commit & push your changes:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git add .
+git commit -a -m 'Prepare to release `7.8.0`'
+git push -u origin release/7.8.0</code></pre>
+</div>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p><code>release/</code>-prefixed branches trigger a particular GitHub Actions
workflow and its run is idempotent.
+You can iterate on the <code>release/7.8.0</code> branch to perfect it.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Verify that the associated <a
href="https://github.com/apache/logging-parent/actions">GitHub Actions
workflow</a> succeeds:</p>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>The <code>project.build.outputTimestamp</code> property in
<code>pom.xml</code> is updated</p>
+</li>
+<li>
+<p><strong>Signed artifacts</strong> are uploaded to the <em>Staging
Repositories</em> in <a
href="https://repository.apache.org/">repository.apache.org</a></p>
+</li>
+<li>
+<p><strong>Signed distribution and its checksum</strong> (e.g.,
<code>apache-logging-parent-7.8.0-{bin,src}.{zip,.zip.asc,.zip.sha512}</code>)
are uploaded to <a
href="https://dist.apache.org/repos/dist/dev/logging/logging-parent">dist.apache.org/repos/dist/<strong>dev</strong>/logging/logging-parent/7.8.0</a>
Subversion repository (along with auxiliary files; website, email texts,
etc.)</p>
+</li>
+<li>
+<p><a href="https://logging.staged.apache.org/logging-parent-7.8.0">The
release staging website</a> is deployed using the freshly populated
<code>release/7.8.0-site-stg-out</code> branch</p>
+</li>
+</ol>
+</div>
+<div class="paragraph">
+<p>If not, commit necessary fixes, push, and repeat.</p>
+</div>
+</li>
+<li>
+<p><em>Close</em> the repository in <a
href="https://repository.apache.org/">repository.apache.org</a> using a
self-explanatory description, e.g., <code>`logging-parent` version `7.8.0`
RC1</code></p>
+</li>
+</ol>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="vote-release"><a class="anchor" href="#vote-release"></a>Vote the
release</h2>
+<div class="sectionbody">
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Send the vote email uploaded to the <a
href="https://dist.apache.org/repos/dist/dev/logging/logging-parent">dist.apache.org/repos/dist/<strong>dev</strong>/logging/logging-parent</a>
Subversion repository</p>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p><strong>Fix the cited <a
href="https://repository.apache.org">repository.apache.org</a> URL</strong> in
the generated email!
+It changes after every Nexus deployment.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Make sure your email is sent in plain text, that is, <a
href="https://infra.apache.org/contrib-email-tips#nohtml">no HTML</a>!
+If you are using GMail, enable the <em>"Plain text mode"</em> while composing
your message.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Once the consensus is reached within the set time frame, respond to the
first post in the thread as follows:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-none hljs">Adding my
+1.
+
+With that, the release passes with 3 binding +1 votes from
<PMC-member-1>, ..., <PMC-member-N>, and me. I will continue the
release process.</code></pre>
+</div>
+</div>
+</li>
+</ol>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="publish-release"><a class="anchor" href="#publish-release"></a>Publish
the release</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="publish-release-git"><a class="anchor"
href="#publish-release-git"></a>In the git repository</h3>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Pull the most recent changes and tags</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git fetch -p</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Tag the release (e.g., <code>rel/7.8.0</code>) and push it</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git tag -a rel/7.8.0 <COMMIT-ID> -m 7.8.0 <i
class="conum" data-value="1"></i><b>(1)</b>
+git push origin rel/7.8.0</code></pre>
+</div>
+</div>
+<div class="colist arabic">
+<table>
+<tr>
+<td><i class="conum" data-value="1"></i><b>1</b></td>
+<td>You can find the <code>COMMIT-ID</code> in the generated vote email.</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>The ASF infrastructure treats <code>rel/</code>-prefixed git tags special
and ensures they are immutable for provenance reasons.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Merge the <code>rel/7.8.0</code> tag (<strong>not</strong> the
<code>release/7.8.0</code> branch!) to <code>main</code></p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git checkout main
+git rebase origin/main # Sync with the remote repository
+git merge rel/7.8.0 # Pull changes up to the newly created
tag</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Set the revision property to the next development version (e.g.,
<code>7.9.0-SNAPSHOT</code>) in <code>pom.xml</code></p>
+</li>
+<li>
+<p>Commit changes and push the <code>main</code> branch</p>
+</li>
+<li>
+<p>Delete the local and remote copies of the <code>release/7.8.0</code>
branch</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git branch -D release/7.8.0
+git push --delete origin release/7.8.0</code></pre>
+</div>
+</div>
+</li>
+</ol>
+</div>
+</div>
+<div class="sect2">
+<h3 id="publish-release-asf"><a class="anchor"
href="#publish-release-asf"></a>In the ASF infrastructure</h3>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p><em>Release</em> the repository in <a
href="https://repository.apache.org">repository.apache.org</a></p>
+</li>
+<li>
+<p>In <a
href="https://dist.apache.org/repos/dist/release/logging/logging-parent">dist.apache.org/repos/dist</a>
Subversion repository,</p>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>create the
<code><strong>release</strong>/logging/logging-parent/7.8.0</code> folder, and
copy the signed sources and their checksum from
<code><strong>dev</strong>/logging/logging-parent/7.8.0</code> to there</p>
+</li>
+<li>
+<p>delete the folder from an earlier release in
<code><strong>release</strong>/logging/logging-parent</code></p>
+</li>
+<li>
+<p>commit your changes in
<code><strong>release</strong>/logging/logging-parent</code></p>
+</li>
+<li>
+<p>delete the <code><strong>dev</strong>/logging/logging-parent/7.8.0</code>
folder (stash the generated announcement email somewhere, you will need it
later on)</p>
+</li>
+<li>
+<p>commit changes your changes in
<code><strong>dev</strong>/logging/logging-parent</code></p>
+</li>
+</ol>
+</div>
+<div class="openblock">
+<div class="content">
+<div class="paragraph">
+<p>These steps can be summarized as follows in shell:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash"># Clone repositories (unless you already have them!)
+svn co https://dist.apache.org/repos/dist/dev/logging logging-dist-dev
+svn co https://dist.apache.org/repos/dist/release/logging logging-dist-rel
+
+# Update `release` folder
+cd logging-dist-rel
+mkdir -p logging-parent/7.8.0
+cp ../logging-dist-dev/logging-parent/7.8.0/*-{bin,src}.* logging-parent/7.8.0/
+svn add logging-parent/7.8.0
+svn commit -m 'Add `logging-parent` version `7.8.0` distribution'
+
+# Update `dev` folder
+cd ../logging-dist-dev
+cp logging-parent/7.8.0/*-email-announce.txt /tmp
+svn rm logging-parent/7.8.0
+svn commit -m 'Remove `logging-parent` version `7.8.0` files
released'</code></pre>
+</div>
+</div>
+</div>
+</div>
+</li>
+<li>
+<p>Report the release at <a
href="https://reporter.apache.org/addrelease.html?logging">reporter.apache.org</a></p>
+</li>
+</ol>
+</div>
+</div>
+<div class="sect2">
+<h3 id="publish-release-github"><a class="anchor"
href="#publish-release-github"></a>In GitHub</h3>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p><a href="https://github.com/apache/logging-parent/releases/new">Create a
new release in GitHub</a>:</p>
+<div class="ulist">
+<ul>
+<li>
+<p>Use the <code>rel/7.8.0</code> tag</p>
+</li>
+<li>
+<p>Copy release notes from the generated emails</p>
+</li>
+</ul>
+</div>
+</li>
+</ol>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="publish-release-website"><a class="anchor"
href="#publish-release-website"></a>Publish the release website</h2>
+<div class="sectionbody">
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Merge the <code>rel/7.8.0</code> tag (<strong>not</strong> the
<code>release/7.8.0</code> branch!) to <code>main-site-pro</code> and push
it</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git checkout main-site-pro
+git rebase origin/main-site-pro # Sync with the remote repository
+git merge rel/7.8.0 # Pull changes up to the newly created tag
+git push origin main-site-pro</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Verify that <a
href="https://github.com/apache/logging-parent/actions/workflows/deploy-site.yaml">the
<code>deploy-site</code> workflow</a> successfully runs the
<code>deploy-site-pro</code> job</p>
+</li>
+<li>
+<p>Verify that <a href="https://logging.apache.org/logging-parent">the project
website</a> is updated</p>
+</li>
+<li>
+<p>Delete the release staging website branch:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs"
data-lang="bash">git push --delete origin
release/7.8.0-site-stg-out</code></pre>
+</div>
+</div>
+</li>
+</ol>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="announce-release"><a class="anchor"
href="#announce-release"></a>Announce the release</h2>
+<div class="sectionbody">
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Send the announcement email uploaded to the <a
href="https://dist.apache.org/repos/dist/dev/logging/logging-parent">dist.apache.org/repos/dist/<strong>dev</strong>/logging/logging-parent/7.8.0</a>
Subversion repository</p>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Make sure your email is sent in plain text, that is, <a
href="https://infra.apache.org/contrib-email-tips#nohtml">no HTML</a>!
+If you are using GMail, enable the <em>"Plain text mode"</em> while composing
your message.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+</ol>
+</div>
+</div>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script>
+<script async src="./_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="./_/js/vendor/tabs.js"></script>
+ </body>
+</html>
diff --git a/release-instructions-xml-schema.html
b/release-instructions-xml-schema.html
new file mode 100644
index 0000000..c3cfd50
--- /dev/null
+++ b/release-instructions-xml-schema.html
@@ -0,0 +1,248 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>XML schema release instructions :: Apache Logging Parent</title>
+ <link rel="canonical"
href="https://logging.apache.org/logging-parent/release-instructions-xml-schema.html">
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="./_/css/site.css">
+<link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="./_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="article">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container" data-component="ROOT" data-version="">
+ <aside class="nav">
+ <div class="panels">
+<div class="nav-panel-menu is-active" data-panel="menu">
+ <nav class="nav-menu">
+ <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all"
style="display: none"></button>
+ <h3 class="title"><a href="index.html">Home</a></h3>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="features.html">Features</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="usage.html">Usage</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-notes.html">Release notes</a>
+ </li>
+</ul>
+ </li>
+ <li class="nav-item" data-depth="0">
+ <button class="nav-item-toggle"></button>
+ <span class="nav-text">Release instructions</span>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-project.html">For
projects</a>
+ </li>
+ <li class="nav-item is-current-page" data-depth="1">
+ <a class="nav-link" href="release-instructions-xml-schema.html">For XML
schemas</a>
+ </li>
+</ul>
+ </li>
+</ul>
+ </nav>
+</div>
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="index.html" class="home-link"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li>Release instructions</li>
+ <li><a href="release-instructions-xml-schema.html">For XML schemas</a></li>
+ </ul>
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules/ROOT/pages/release-instructions-xml-schema.adoc">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<aside class="toc sidebar" data-title="Contents" data-levels="2">
+ <div class="toc-menu"></div>
+</aside>
+<article class="doc">
+<h1 class="page">XML schema release instructions</h1>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>This section explains how to publish XML schemas (i.e., XSD files) of
projects.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="preliminaries"><a class="anchor"
href="#preliminaries"></a>Preliminaries</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>It is crucial to understand certain things while doing an XML schema
release:</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Projects and XML schemas have different lifecycles</dt>
+<dd>
+<p>A new release of a project does not necessarily mean a new release of its
XML schemas.
+XML schemas might have been untouched, or they might contain minor changes
while the project itself contains breaking changes, etc.
+Hence, the project version and the XML schema version most of the time differ.
+Check if there are indeed changes to the XML schema.
+If so, set its version accordingly.</p>
+<div class="paragraph">
+<p>Consider the following examples:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Log4j Tools <code>0.2.0</code> contains the very first version of Log4j
Changelog XSD, that is, <code>log4j-changelog-0.1.0.xsd</code>.</p>
+</li>
+<li>
+<p>The next release of Log4j Tools contains a small change to the Log4j
Changelog XSD.
+Hence, Log4j Tools <code>0.3.0</code> publishes
<code>log4j-changelog-0.1.1.xsd</code>.
+That is, the project upgraded from <code>0.2.0</code> to <code>0.3.0</code>
(note the minor version bump), whereas the XSD upgraded from <code>0.1.0</code>
to <code>0.1.1</code> (note the patch version bump).</p>
+</li>
+<li>
+<p>Log4j Tools <code>0.6.0</code> does not contain any changes to the Log4j
Changelog XSD.
+Hence, it does not publish an XSD.</p>
+</li>
+</ul>
+</div>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Log4j XSDs are auto-generated at compile time.
+Members annotated with <code>@Plugin</code> et al. will have direct influence
on the XSD generated.
+You are strongly advised to compare the new XSD with an earlier version (via
<a href="https://pypi.org/project/xmldiff/">xmldiff</a>?) to verify the changes
and decide on the XSD version.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</dd>
+<dt class="hdlist1">XML schemas are generally published earlier than a
release</dt>
+<dd>
+<p>Projects containing XML schemas most of the time need to refer to those
files in their sources, tests, etc.
+Hence, XML schemas need to be published first so that the project itself can
refer to them.</p>
+</dd>
+<dt class="hdlist1">XML schemas are generally published directly to the
production (i.e., non-staging) site</dt>
+<dd>
+<p>Once an XML schema is referred using a URL in the sources, the released
project artifacts will contain those referrals as is.
+That is, if sources refer to
<code>https://logging.<strong>staged</strong>.apache.org/xml/ns/foo.xml</code>,
we cannot magically switch them to
<code>https://logging.apache.org/xml/ns/foo.xml</code> in the released
artifacts.
+Hence, XML schemas are generally published directly to the production site.</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="instructions"><a class="anchor"
href="#instructions"></a>Instructions</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The instructions on how to publish XML schemas are shared below:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Check out the <code>main</code> branch of the <a
href="https://github.com/apache/logging-site/tree/main/xml/ns"><code>logging-site</code></a>
repository</p>
+</li>
+<li>
+<p>Update the contents of the <code>xml/ns</code> folder</p>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>Adhere to the conventions followed in the existing content there</p>
+</li>
+<li>
+<p>Make sure that the root elements in the new XSD files contain the correct
<code>version</code> attribute</p>
+</li>
+</ol>
+</div>
+</li>
+<li>
+<p>Commit & push your changes</p>
+</li>
+<li>
+<p>Verify that your changes are visible in <a
href="https://logging.staged.apache.org/xml/ns">logging.<strong>staged</strong>.apache.org/xml/ns</a></p>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Under the hood, ASF INFRA will compile the Jekyll site, commit & push
its changes to the <code>asf-staging</code> branch.
+Later on, ASF INFRA will pick up these changes from the
<code>asf-staging</code> branch and place it into the associated Apache HTTP
Server folder.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Check out the <code>asf-site</code> branch</p>
+</li>
+<li>
+<p>Rebase it from <code>asf-staging</code> (i.e., <code>git rebase
origin/asf-staging</code>) and push it</p>
+</li>
+<li>
+<p>Verify that your changes are visible in <a
href="https://logging.apache.org/xml/ns">logging.apache.org/xml/ns</a></p>
+</li>
+</ol>
+</div>
+</div>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script>
+<script async src="./_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="./_/js/vendor/tabs.js"></script>
+ </body>
+</html>
diff --git a/release-notes.html b/release-notes.html
new file mode 100644
index 0000000..7b2b163
--- /dev/null
+++ b/release-notes.html
@@ -0,0 +1,771 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>Release notes :: Apache Logging Parent</title>
+ <link rel="canonical"
href="https://logging.apache.org/logging-parent/release-notes.html">
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="./_/css/site.css">
+<link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="./_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="article">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container" data-component="ROOT" data-version="">
+ <aside class="nav">
+ <div class="panels">
+<div class="nav-panel-menu is-active" data-panel="menu">
+ <nav class="nav-menu">
+ <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all"
style="display: none"></button>
+ <h3 class="title"><a href="index.html">Home</a></h3>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="features.html">Features</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="usage.html">Usage</a>
+ </li>
+ <li class="nav-item is-current-page" data-depth="1">
+ <a class="nav-link" href="release-notes.html">Release notes</a>
+ </li>
+</ul>
+ </li>
+ <li class="nav-item" data-depth="0">
+ <button class="nav-item-toggle"></button>
+ <span class="nav-text">Release instructions</span>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-project.html">For
projects</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-xml-schema.html">For XML
schemas</a>
+ </li>
+</ul>
+ </li>
+</ul>
+ </nav>
+</div>
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="index.html" class="home-link"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li><a href="release-notes.html">Release notes</a></li>
+ </ul>
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules/ROOT/pages/release-notes.adoc">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<aside class="toc sidebar" data-title="Contents" data-levels="1">
+ <div class="toc-menu"></div>
+</aside>
+<article class="doc">
+<h1 class="page">Release notes</h1>
+<div class="sect1">
+<h2 id="release-notes-11-0-0"><a class="anchor"
href="#release-notes-11-0-0"></a>11.0.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2024-04-15</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This release contains a big revamp to the website build and several other
minor enhancements.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-11-0-0-website-build"><a class="anchor"
href="#release-notes-11-0-0-website-build"></a>Website build changes</h3>
+<div class="paragraph">
+<p>The website build system is migrated from
<code>asciidoctor-maven-plugin</code> to Antora.
+This implies that <code>src/site</code> and <code>generate-email.sh</code>
files need to be adapted, and <code>target/site</code> can be viewed without
needing a local web server.</p>
+</div>
+<div class="paragraph">
+<p>The Maven <code>site</code> phase is re-engineered such that <em>generated
sources</em> (i.e., <code>src/site/_release_notes</code> and
<code>src/site/_constants.adoc</code>) will be targeted to
<code>target/generated-site</code> and the website will be built from there.
+This avoids the need to commit generated sources to the repository and, hence,
works around changelog merge conflict problems.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-11-0-0-website-deployment"><a class="anchor"
href="#release-notes-11-0-0-website-deployment"></a>Website deployment
changes</h3>
+<div class="paragraph">
+<p>The newly added <code>site-deploy-reusable.yaml</code> GitHub Actions
workflow enables to automate the website deployment.
+Using the <code><source-branch>-site-<environment>-out</code>
branch naming convention, the Maven <code>site</code> goal running on</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>the <code>main</code> branch populates the <code>main-site-stg-out</code>
branch serving the <code>logging.staged.apache.org/logging-parent</code></p>
+</li>
+<li>
+<p>the <code>main-site-pro</code> branch populates the
<code>main-site-pro-out</code> branch serving the
<code>logging.apache.org/logging-parent</code></p>
+</li>
+<li>
+<p>the <code>release/<version></code> branch populates the
<code>release/<version>-site-stg-out</code> branch serving the
<code>logging.staged.apache.org/logging-parent-<version></code></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Refer to the usage and project release instructions pages for details.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-11-0-0-added"><a class="anchor"
href="#release-notes-11-0-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Add <code>coverage</code> profile to generate a test coverage report (<a
href="https://github.com/apache/logging-parent/pull/140">140</a>)</p>
+</li>
+<li>
+<p>Add <code>deploy-site-yaml</code> GitHub actions workflow to automate the
website deployment</p>
+</li>
+<li>
+<p>Add instructions on XML schema publication (<a
href="https://github.com/apache/logging-parent/issues/138">138</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-11-0-0-changed"><a class="anchor"
href="#release-notes-11-0-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Replace <code>process-sbom</code> script with CycloneDX plugin
configuration (<a
href="https://github.com/apache/logging-parent/issues/105">105</a>)</p>
+</li>
+<li>
+<p>Support parallel releases by uploading the distribution to
<code><projectId>/<version></code> folders. This is needed for
parallel Log4j 2 and 3 releases. (<a
href="https://github.com/apache/logging-parent/issues/139">139</a>)</p>
+</li>
+<li>
+<p>Migrate website support from <code>asciidoctor-maven-plugin</code> to
Antora</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-11-0-0-updated"><a class="anchor"
href="#release-notes-11-0-0-updated"></a>Updated</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Update <code>com.diffplug.spotless:spotless-maven-plugin</code> to version
<code>2.43.0</code> (<a
href="https://github.com/apache/logging-parent/pull/108">108</a>)</p>
+</li>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-maven-plugin</code> to version
<code>4.8.4.0</code> (<a
href="https://github.com/apache/logging-parent/pull/156">156</a>)</p>
+</li>
+<li>
+<p>Update <code>com.google.errorprone:error_prone_core</code> to version
<code>2.26.1</code> (<a
href="https://github.com/apache/logging-parent/pull/134">134</a>)</p>
+</li>
+<li>
+<p>Update <code>com.palantir.javaformat:palantir-java-format</code> to version
<code>2.43.0</code> (<a
href="https://github.com/apache/logging-parent/pull/154">154</a>)</p>
+</li>
+<li>
+<p>Update <code>org.apache.logging.log4j:log4j-changelog-maven-plugin</code>
to version <code>0.8.0</code> (<a
href="https://github.com/apache/logging-parent/pull/146">146</a>)</p>
+</li>
+<li>
+<p>Update <code>org.apache.maven.plugins:maven-artifact-plugin</code> to
version <code>3.5.1</code> (<a
href="https://github.com/apache/logging-parent/pull/149">149</a>)</p>
+</li>
+<li>
+<p>Update <code>org.codehaus.mojo:flatten-maven-plugin</code> to version
<code>1.6.0</code> (<a
href="https://github.com/apache/logging-parent/pull/102">102</a>)</p>
+</li>
+<li>
+<p>Update <code>org.cyclonedx:cyclonedx-maven-plugin</code> to version
<code>2.8.0</code> (<a
href="https://github.com/apache/logging-parent/pull/145">145</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-6-0"><a class="anchor"
href="#release-notes-10-6-0"></a>10.6.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2024-01-11</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains several small changes to the build pipeline.</p>
+</div>
+<div class="paragraph">
+<p>Most notably it bans wildcard imports from source code, which will require
expanding those imports before upgrading <code>logging-parent</code>.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-6-0-added"><a class="anchor"
href="#release-notes-10-6-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Add JSpecify to dependency management. (<a
href="https://github.com/apache/logging-parent/pull/88">88</a>)</p>
+</li>
+<li>
+<p>Add enforcer rule to ban wildcard imports. All imports must be expanded to
provide better comparison of branches. (<a
href="https://github.com/apache/logging-parent/pull/63">63</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-6-0-changed"><a class="anchor"
href="#release-notes-10-6-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Merge Dependabot PRs instead of closing them. (<a
href="https://github.com/apache/logging-parent/pull/82">82</a>)</p>
+</li>
+<li>
+<p>Disable <a
href="https://bnd.bndtools.org/instructions/jpms-multi-release.html"><code>-jpms-multi-release</code></a>
BND option. (<a
href="https://github.com/apache/logging-parent/pull/93">93</a>)</p>
+</li>
+<li>
+<p>Clean up residual <code>module-info.class</code> before compilation. (<a
href="https://github.com/apache/logging-parent/pull/90">90</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-6-0-updated"><a class="anchor"
href="#release-notes-10-6-0-updated"></a>Updated</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Update <code>com.google.errorprone:error_prone_core</code> to version
<code>2.24.1</code> (<a
href="https://github.com/apache/logging-parent/pull/89">89</a>)</p>
+</li>
+<li>
+<p>Update <code>github/codeql-action</code> to version <code>3.23.0</code> (<a
href="https://github.com/apache/logging-parent/pull/91">91</a>)</p>
+</li>
+<li>
+<p>Update <code>org.apache.rat:apache-rat-plugin</code> to version
<code>0.16</code> (<a
href="https://github.com/apache/logging-parent/pull/92">92</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-5-0"><a class="anchor"
href="#release-notes-10-5-0"></a>10.5.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-12-18</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains dependency updates and a change in the way BND
is employed.</p>
+</div>
+<div class="paragraph">
+<p>BND Maven Plugins are upgraded to version <code>7.0.0</code>, which
requires Java 17.
+Log4j was the blocker for this upgrade and the issue is resolved in <a
href="https://github.com/apache/logging-log4j2/pull/2021">apache/logging-log4j2#2021</a>.
+Note that BND Maven Plugins version <code>7.0.0</code> increased the minimum
required Maven version to <code>3.8.1</code>.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-5-0-changed"><a class="anchor"
href="#release-notes-10-5-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Switch from <code>bnd:jar</code> to <code>bnd:bnd-process</code> to improve
integration with the ecosystem; IDEs, Maven plugins, etc. (<a
href="https://github.com/apache/logging-parent/issues/69">69</a>)</p>
+</li>
+<li>
+<p>Replace <code>log4j-changelog</code> entry type of <code>dependabot</code>
updates from <code>changed</code> to <code>updated</code></p>
+</li>
+<li>
+<p>Minimum required Maven version is increased to <code>3.8.1</code> due to
BND Maven Plugin updates</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-5-0-updated"><a class="anchor"
href="#release-notes-10-5-0-updated"></a>Updated</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Update <code>biz.aQute.bnd:bnd-baseline-maven-plugin</code> to version
<code>7.0.0</code> (<a
href="https://github.com/apache/logging-parent/pull/78">78</a>)</p>
+</li>
+<li>
+<p>Update <code>biz.aQute.bnd:bnd-maven-plugin</code> to version
<code>7.0.0</code></p>
+</li>
+<li>
+<p>Update <code>com.diffplug.spotless:spotless-maven-plugin</code> to version
<code>2.41.1</code> (<a
href="https://github.com/apache/logging-parent/pull/70">70</a>)</p>
+</li>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-annotations</code> to version
<code>4.8.3</code> (<a
href="https://github.com/apache/logging-parent/pull/80">80</a>)</p>
+</li>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-maven-plugin</code> to version
<code>4.8.2.0</code> (<a
href="https://github.com/apache/logging-parent/pull/71">71</a>)</p>
+</li>
+<li>
+<p>Update <code>com.palantir.javaformat:palantir-java-format</code> to version
<code>2.39.0</code></p>
+</li>
+<li>
+<p>Update <code>org.apache:apache</code> to version <code>31</code> (<a
href="https://github.com/apache/logging-parent/pull/73">73</a>)</p>
+</li>
+<li>
+<p>Update <code>org.apache.logging.log4j:log4j-changelog-maven-plugin</code>
to version <code>0.7.0</code> (<a
href="https://github.com/apache/logging-parent/pull/84">84</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-4-0"><a class="anchor"
href="#release-notes-10-4-0"></a>10.4.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-11-13</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains several small improvements.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-4-0-added"><a class="anchor"
href="#release-notes-10-4-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Add deterministic Palantir Java formatter</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-4-0-changed"><a class="anchor"
href="#release-notes-10-4-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Increase directory scanning depth from 8 to 32 in the distribution
BeanShell script</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-3-0"><a class="anchor"
href="#release-notes-10-3-0"></a>10.3.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-11-09</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains several small improvements.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-3-0-added"><a class="anchor"
href="#release-notes-10-3-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Add support to extend the <code>bnd-maven-plugin</code> configuration with
<code>bnd-extra-config</code> property (<a
href="https://github.com/apache/logging-log4j2/issues/1895">apache/logging-log4j2#1895</a>)</p>
+</li>
+<li>
+<p>Add support to replace <code>project.build.outputTimestamp</code> Maven
property in CI (<a
href="https://github.com/apache/logging-parent/issues/50">50</a>)</p>
+</li>
+<li>
+<p>Add XSLT transformation step to add a deterministic
<code>serialNumber</code> and VDR links to the SBOM</p>
+</li>
+<li>
+<p>Add support for an optional <code>spotbugs-exclude.xml</code> file</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-3-0-changed"><a class="anchor"
href="#release-notes-10-3-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p><code>deploy-release-reusable.yaml</code> is improved to automatically
derive deployed artifacts as attachments. This renders both
<code>distribution-attachment-filepath-pattern</code> and
<code>distribution-attachment-count</code> input arguments redundant for almost
all cases.</p>
+</li>
+<li>
+<p>Disable the usage of <code><distributionManagement></code> and alpha
releases in the <code>bnd-baseline-maven-plugin</code></p>
+</li>
+<li>
+<p>Convert <code>bnd-maven-plugin</code> API leakage warnings to errors (<a
href="https://github.com/apache/logging-log4j2/issues/1895">apache/logging-log4j2#1895</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-3-0-fixed"><a class="anchor"
href="#release-notes-10-3-0-fixed"></a>Fixed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Fix broken changelog entry validation</p>
+</li>
+<li>
+<p>Attach <code>flatten:clean</code> to <code>clean</code> phase</p>
+</li>
+<li>
+<p>Add missing <code>Implementation-</code> and <code>Specification-</code>
entries in <code>MANIFEST.MF</code> to <code>bnd-maven-plugin</code>
configuration (<a
href="https://github.com/apache/logging-log4j2/issues/1923">apache/logging-log4j2#1923</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-3-0-updated"><a class="anchor"
href="#release-notes-10-3-0-updated"></a>Updated</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-annotations</code> to version
<code>4.8.1</code> (<a
href="https://github.com/apache/logging-parent/pull/58">58</a>)</p>
+</li>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-maven-plugin</code> to version
<code>4.8.1.0</code> (<a
href="https://github.com/apache/logging-parent/pull/57">57</a>)</p>
+</li>
+<li>
+<p>Update <code>com.google.errorprone:error_prone_core</code> to version
<code>2.23.0</code> (<a
href="https://github.com/apache/logging-parent/pull/49">49</a>)</p>
+</li>
+<li>
+<p>Update <code>org.apache.maven.plugins:maven-artifact-plugin</code> to
version <code>3.5.0</code></p>
+</li>
+<li>
+<p>Update <code>org.cyclonedx:cyclonedx-maven-plugin</code> to version
<code>2.7.10</code> (<a
href="https://github.com/apache/logging-parent/pull/54">54</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-2-0"><a class="anchor"
href="#release-notes-10-2-0"></a>10.2.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-10-18</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains several small improvements.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-2-0-added"><a class="anchor"
href="#release-notes-10-2-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Added support for auto-generating CycloneDX Software Bill of Materials
(SBOM)</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-2-0-changed"><a class="anchor"
href="#release-notes-10-2-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Add a compulsory <code>bnd-baseline-maven-plugin</code> execution to check
for breaking API changes</p>
+</li>
+<li>
+<p>Apply the default <code>bnd-maven-plugin</code> configuration to all the
plugin’s goals</p>
+</li>
+<li>
+<p>Moves <code>.flattened-pom.xml</code> to the same directory as
<code>pom.xml</code> to preserve the relative parent path. This requires adding
<code>.flattened-pom.xml</code> to the <code>.gitignore</code> file of the
repository.</p>
+</li>
+<li>
+<p>Update <code>log4j-changelog</code> XSD (used for validating changelog
entries) to version <code>0.1.2</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-2-0-fixed"><a class="anchor"
href="#release-notes-10-2-0-fixed"></a>Fixed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Prioritize definitions in <code>bnd-extra-*</code> variables over those
inherited (<a
href="https://github.com/apache/logging-parent/issues/39">39</a>)</p>
+</li>
+<li>
+<p>Keep parent in <code>flatten-bom</code> configuration (<a
href="https://github.com/apache/logging-parent/issues/37">37</a>)</p>
+</li>
+<li>
+<p>Remove <code>build</code> in <code>flatten-bom</code> configuration</p>
+</li>
+<li>
+<p>Fixed the archiving of symbolically linked directories in the
<code>distribution</code> Maven profile (<a
href="https://github.com/apache/logging-parent/issues/43">43</a>)</p>
+</li>
+<li>
+<p>Used specific execution IDs in <code>defaultGoal</code>s to avoid running
unwanted plugins</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-2-0-updated"><a class="anchor"
href="#release-notes-10-2-0-updated"></a>Updated</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Update <code>org.apache.logging.log4j:log4j-changelog-maven-plugin</code>
to version <code>0.5.0</code></p>
+</li>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-annotations</code> to version
<code>4.8.0</code> (<a
href="https://github.com/apache/logging-parent/pull/44">44</a>)</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-1-1"><a class="anchor"
href="#release-notes-10-1-1"></a>10.1.1</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-10-02</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This patch release contains minor fixes addressing issues blocking the
release of <code>log4j-tools</code>, <code>log4j-kotlin</code>, etc.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-1-added"><a class="anchor"
href="#release-notes-10-1-1-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Used <code>project.build.outputTimestamp</code> to timestamp generated
distribution files</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-1-changed"><a class="anchor"
href="#release-notes-10-1-1-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Changes the default OSGi and module name to use full stops <code>.</code>
instead of non-alphanumeric characters</p>
+</li>
+<li>
+<p>Update <code>com.diffplug.spotless:spotless-maven-plugin</code> to version
<code>2.40.0</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-1-fixed"><a class="anchor"
href="#release-notes-10-1-1-fixed"></a>Fixed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Fixed checksum (i.e., <code>*.sha512</code>) file format</p>
+</li>
+<li>
+<p>Fix BND module name detection on multi-release JARs</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-1-0"><a class="anchor"
href="#release-notes-10-1-0"></a>10.1.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-09-28</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release focuses on shipping AsciiDoc-based website generation
convenience targeting the <code>src/site</code> folder.
+As a part of this effort, <code>logging-parent</code> started publishing <a
href="https://logging.apache.org/logging-parent/latest">its own website</a> and
<code>log4j-changelog</code> support is switched from Markdown to AsciiDoc.</p>
+</div>
+<div class="paragraph">
+<p>The introduced <a
href="https://github.com/bndtools/bnd/blob/master/maven-plugins/bnd-maven-plugin"><code>bnd-maven-plugin</code></a>
default auto-generates both OSGi and JPMS descriptors.
+Users only need to annotate packages that are to be exported with
<code>org.osgi.annotation.bundle.Export</code>, plugin will do the rest of the
magic.
+Hence, no need for custom <code>.bnd</code> and/or
<code>module-info.java</code> files anymore.
+In particular, we expect the absence of <code>module-info.java</code> files to
avoid several IDE and testing related headaches.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-0-added"><a class="anchor"
href="#release-notes-10-1-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Added <code>asciidoc</code> and <code>constants-tmpl-adoc</code> profiles
to generate AsciiDoc-based websites from <code>src/site</code></p>
+</li>
+<li>
+<p>Added support to auto-generate changelog entries for
<code>dependabot</code> updates</p>
+</li>
+<li>
+<p>Added <code>bnd-maven-plugin</code> defaults to auto-generate both OSGi and
JPMS descriptors</p>
+</li>
+<li>
+<p>Added CI report uploading in case of test or reproducibility failures (<a
href="https://github.com/apache/logging-parent/issues/28">28</a>)</p>
+</li>
+<li>
+<p>Started publishing <a href="https://logging.apache.org/logging-parent">the
project website</a></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-0-changed"><a class="anchor"
href="#release-notes-10-1-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Switched the default <code>log4j-changelog</code> configuration from
Markdown (<code>.release-notes.md.ftl</code> and <code>.index.md.ftl</code>) to
AsciiDoc (<code>.release-notes.adoc.ftl</code> and
<code>.index.adoc.ftl</code>)</p>
+</li>
+<li>
+<p>Update <code>actions/checkout</code> to version <code>4.1.0</code></p>
+</li>
+<li>
+<p>Update <code>com.github.spotbugs:spotbugs-maven-plugin</code> to version
<code>4.7.3.6</code></p>
+</li>
+<li>
+<p>Update <code>com.google.errorprone:error_prone_core</code> to version
<code>2.22.0</code></p>
+</li>
+<li>
+<p>Update <code>org.apache:apache</code> to version <code>30</code></p>
+</li>
+<li>
+<p>Update <code>org.osgi:osgi.annotation</code> to version
<code>8.1.0</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-0-fixed"><a class="anchor"
href="#release-notes-10-1-0-fixed"></a>Fixed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Replaced incorrect <code>java.version</code> Maven property override with
<code>maven.compiler.{source,release,target}</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-1-0-removed"><a class="anchor"
href="#release-notes-10-1-0-removed"></a>Removed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Removed <code>project.build.outputTimestamp</code> override since it is
already provided by the parent POM and its old value <code>0</code> was causing
<a
href="https://github.com/spring-projects/spring-boot/pull/37438">reproducibility
issues</a> for <code>spring-boot:repackage</code></p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="release-notes-10-0-0"><a class="anchor"
href="#release-notes-10-0-0"></a>10.0.0</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Release date</dt>
+<dd>
+<p>2023-09-08</p>
+</dd>
+</dl>
+</div>
+<div class="paragraph">
+<p>This minor release contains various improvements that we expect to relieve
the load on <code>pom.xml</code> and GitHub Actions workflows of Maven-based
projects we parent.
+This is of particular importance while managing and cutting releases from
multiple repositories.
+See <code>README.adoc</code> for the complete list of features and their
usage.</p>
+</div>
+<div class="paragraph">
+<p>See <a
href="https://github.com/apache/logging-log4j-tools/actions/runs/6120297528">this
<code>log4j-tools</code> GitHub Actions workflow run</a> demonstrating a
successful release cut using a SNAPSHOT version of this
<code>logging-parent</code> release.
+All preparations (release notes, source and binary distributions, vote &
announcement emails, etc.) are staged to both Nexus and SVN and waiting the
release manager to proceed.</p>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-0-0-added"><a class="anchor"
href="#release-notes-10-0-0-added"></a>Added</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Added <code>changelog-export</code> profile to easily export changelogs to
Markdown files</p>
+</li>
+<li>
+<p>Added <code>changelog-release</code> profile to easily move
<code>src/changelog/.?.x.x</code> contents to their associated release
directory</p>
+</li>
+<li>
+<p>Added <code>deploy</code> profile to ease the Maven <code>deploy</code>
goal</p>
+</li>
+<li>
+<p>Added <code>asciidoc</code> profile to easily create a distribution file
containing Git-tracked sources, release notes, binary attachments,
<code>NOTICE.txt</code>, etc.</p>
+</li>
+<li>
+<p>Documented release instructions (i.e., <code>RELEASING.md</code>)</p>
+</li>
+<li>
+<p>Added <code>release</code> profile to share common release-specific Maven
configuration</p>
+</li>
+<li>
+<p>Added reusable GitHub Actions workflows to share CI boilerplate for other
repositories</p>
+</li>
+<li>
+<p>Switched to using <code>log4j-changelog-maven-plugin</code> for managing
changelog and release notes</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="release-notes-10-0-0-changed"><a class="anchor"
href="#release-notes-10-0-0-changed"></a>Changed</h3>
+<div class="ulist">
+<ul>
+<li>
+<p>Switched to semantic versioning (old version: <code>9</code>, new version:
<code>10.0.0</code>)</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script>
+<script async src="./_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="./_/js/vendor/tabs.js"></script>
+ </body>
+</html>
diff --git a/sitemap.xml b/sitemap.xml
new file mode 100644
index 0000000..f926a52
--- /dev/null
+++ b/sitemap.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<url>
+<loc>https://logging.apache.org/logging-parent/features.html</loc>
+<lastmod>2024-04-15T10:53:36.411Z</lastmod>
+</url>
+<url>
+<loc>https://logging.apache.org/logging-parent/index.html</loc>
+<lastmod>2024-04-15T10:53:36.411Z</lastmod>
+</url>
+<url>
+<loc>https://logging.apache.org/logging-parent/release-instructions-project.html</loc>
+<lastmod>2024-04-15T10:53:36.411Z</lastmod>
+</url>
+<url>
+<loc>https://logging.apache.org/logging-parent/release-instructions-xml-schema.html</loc>
+<lastmod>2024-04-15T10:53:36.411Z</lastmod>
+</url>
+<url>
+<loc>https://logging.apache.org/logging-parent/release-notes.html</loc>
+<lastmod>2024-04-15T10:53:36.411Z</lastmod>
+</url>
+<url>
+<loc>https://logging.apache.org/logging-parent/usage.html</loc>
+<lastmod>2024-04-15T10:53:36.411Z</lastmod>
+</url>
+</urlset>
diff --git a/usage.html b/usage.html
new file mode 100644
index 0000000..0259fe8
--- /dev/null
+++ b/usage.html
@@ -0,0 +1,341 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <title>Usage :: Apache Logging Parent</title>
+ <link rel="canonical"
href="https://logging.apache.org/logging-parent/usage.html">
+ <meta name="generator" content="Antora 3.2.0-alpha.4">
+<link rel="stylesheet" href="./_/css/site.css">
+<link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon">
+<!-- `@asciidoctor/tabs` extension styles -->
+<link rel="stylesheet" href="./_/css/vendor/tabs.css">
+<style>
+ /* `page-toclevels` greater than 4 are not supported by Antora UI, patching
it: */
+ .toc .toc-menu li[data-level="4"] a {
+ padding-left: 2.75rem
+ }
+ /* Replace the default highlight.js color for strings from red to green: */
+ .hljs-string {
+ color: #0f8532;
+ }
+</style>
+ </head>
+ <body class="article">
+<header class="header">
+ <nav class="navbar">
+ <div class="navbar-brand">
+ <span class="navbar-item title">Apache Logging Parent</span>
+ </div>
+ <div id="topbar-nav" class="navbar-menu">
+ <div class="navbar-end">
+ <a class="navbar-item" href="https://logging.apache.org">a subproject
of <strong>Apache Logging Services</strong></a>
+ </div>
+ </div>
+ </nav>
+</header>
+<div class="body">
+<div class="nav-container" data-component="ROOT" data-version="">
+ <aside class="nav">
+ <div class="panels">
+<div class="nav-panel-menu is-active" data-panel="menu">
+ <nav class="nav-menu">
+ <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all"
style="display: none"></button>
+ <h3 class="title"><a href="index.html">Home</a></h3>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="features.html">Features</a>
+ </li>
+ <li class="nav-item is-current-page" data-depth="1">
+ <a class="nav-link" href="usage.html">Usage</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-notes.html">Release notes</a>
+ </li>
+</ul>
+ </li>
+ <li class="nav-item" data-depth="0">
+ <button class="nav-item-toggle"></button>
+ <span class="nav-text">Release instructions</span>
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-project.html">For
projects</a>
+ </li>
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="release-instructions-xml-schema.html">For XML
schemas</a>
+ </li>
+</ul>
+ </li>
+</ul>
+ </nav>
+</div>
+ </div>
+ </aside>
+</div>
+<main class="article">
+<div class="toolbar" role="navigation">
+<button class="nav-toggle"></button>
+ <a href="index.html" class="home-link"></a>
+<nav class="breadcrumbs" aria-label="breadcrumbs">
+ <ul>
+ <li><a href="index.html">Home</a></li>
+ <li><a href="usage.html">Usage</a></li>
+ </ul>
+</nav>
+<div class="edit-this-page"><a
href="https://github.com/apache/logging-parent/edit/main/src/site/antora/modules/ROOT/pages/usage.adoc">Edit
this Page</a></div>
+</div>
+ <div class="content">
+<aside class="toc sidebar" data-title="Contents" data-levels="2">
+ <div class="toc-menu"></div>
+</aside>
+<article class="doc">
+<h1 class="page">Usage</h1>
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>You can use Logging Parent as follows:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Add <code>org.apache.logging:logging-parent:11.0.0</code> as a
<code>parent</code> to your <code>pom.xml</code></p>
+</li>
+<li>
+<p>You may need to add <code>.mvn/jvm.config</code> to your project. See <a
href="https://github.com/apache/logging-log4j2/blob/2.x/.mvn/jvm.config">this</a>
as an example.</p>
+</li>
+<li>
+<p>Check if <code>./mvnw verify</code> succeeds, otherwise make necessary
changes</p>
+</li>
+<li>
+<p>Copy and adapt the support files (<code>.gitignore</code>,
<code>.github/workflows/build.yaml</code>, etc.)</p>
+</li>
+<li>
+<p>Copy and adapt Log4j Changelog files:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><code>src/changelog/.<majorVersion>.x.x/.release-notes.adoc.ftl</code></p>
+</li>
+<li>
+<p><code>src/changelog/.changelog.adoc.ftl</code></p>
+</li>
+<li>
+<p><code>src/changelog/.index.adoc.ftl</code></p>
+</li>
+</ul>
+</div>
+</li>
+<li>
+<p>In order to create an Antora-based site:</p>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>Copy the following files and adapt them:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><code>antora-playbook.yaml</code></p>
+</li>
+<li>
+<p><code>package.json</code></p>
+</li>
+<li>
+<p><code>src/site/antora/antora.yml</code></p>
+</li>
+<li>
+<p><code>src/site/antora/.antora.yml</code></p>
+</li>
+<li>
+<p><code>src/site/antora/modules/ROOT/pages/release-notes.adoc</code></p>
+</li>
+</ul>
+</div>
+</li>
+<li>
+<p>Build the website using <code>./mvnw site</code></p>
+</li>
+<li>
+<p>Check out the website generated to <code>target/site</code> by pointing a
browser to it</p>
+</li>
+</ol>
+</div>
+</li>
+</ol>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="website"><a class="anchor" href="#website"></a>Website deployment</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Using <code>deploy-site-reusable.yaml</code> reusable GitHub Actions
workflow, you can automate the website deployments for staging and production
environments.</p>
+</div>
+<div class="sect2">
+<h3 id="website-logging-parent"><a class="anchor"
href="#website-logging-parent"></a>Example: Logging Parent branching scheme</h3>
+<div class="paragraph">
+<p>See how <a
href="https://github.com/apache/logging-parent/blob/main/.github/workflows/deploy-site.yaml"><code>deploy-site.yaml</code>
of Logging Parent</a> achieves that using the</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-none
hljs"><source-branch>-site-<environment>-out</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>branch naming convention:</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Staging website</dt>
+<dd>
+<p><a href="https://logging.staged.apache.org/logging-parent"
class="bare">https://logging.staged.apache.org/logging-parent</a></p>
+</dd>
+<dt class="hdlist1">Production website</dt>
+<dd>
+<p><a href="https://logging.apache.org/logging-parent"
class="bare">https://logging.apache.org/logging-parent</a></p>
+</dd>
+<dt class="hdlist1">Release staging website</dt>
+<dd>
+<p><a href="https://logging.staged.apache.org/logging-parent-<version>"
class="bare">https://logging.staged.apache.org/logging-parent-<version></a></p>
+</dd>
+<dt class="hdlist1">Branch <code>main</code></dt>
+<dd>
+<p>Contains the <em>sources</em> (i.e., AsciiDoc files) to build <em>the
staging website</em>.</p>
+</dd>
+<dt class="hdlist1">Branch <code>main-site-stg-out</code></dt>
+<dd>
+<p>Populated automatically by the workflow triggered for changes on
<code>main</code>.
+It contains the <em>contents</em> (i.e., HTML files) of the <em>the staging
website</em>.
+In short, CI builds <code>main</code> and copies the generated
<code>target/site</code> to <code>main-site-stg-out</code>.</p>
+</dd>
+<dt class="hdlist1">Branch <code>main-site-pro</code></dt>
+<dd>
+<p>Contains the <em>sources</em> (i.e., AsciiDoc files) to build the <em>the
production website</em>.
+It is <em>manually populated</em> by maintainers. For instance,</p>
+<div class="ulist">
+<ul>
+<li>
+<p>after a release, the release tag is merged to <code>main-site-pro</code></p>
+</li>
+<li>
+<p>when there are minor website fixes in <code>main</code> that can also go to
the production website, they are <code>cherry-pick</code>ed onto the
<code>main-site-pro</code></p>
+</li>
+<li>
+<p>when there are production-only website fixes, they are committed to
<code>main-site-pro</code></p>
+</li>
+</ul>
+</div>
+</dd>
+<dt class="hdlist1">Branch <code>main-site-pro-out</code></dt>
+<dd>
+<p>Populated automatically by the workflow triggered for changes on
<code>main-site-pro</code>.
+It contains the <em>contents</em> (i.e., HTML files) of <em>the production
website</em>.
+In short, CI builds <code>main-site-pro</code> and copies the generated
<code>target/site</code> to <code>main-site-pro-out</code>.</p>
+</dd>
+<dt class="hdlist1">Branch <code>release/<version></code></dt>
+<dd>
+<p>Contains the <em>sources</em> (i.e., AsciiDoc files) to build <em>the
release staging website</em>.
+It is <em>manually populated</em> by the release manager during a release.</p>
+</dd>
+<dt class="hdlist1">Branch
<code>release/<version>-site-stg-out</code></dt>
+<dd>
+<p>Populated automatically by the workflow triggered for changes on
<code>release/<version></code>.
+It contains the <em>contents</em> (i.e., HTML files) of <em>the release
staging website</em>.
+In short, CI builds <code>release/<version></code> and copies the
generated <code>target/site</code> to
<code>release/<version>-site-stg-out</code>.</p>
+</dd>
+</dl>
+</div>
+<div class="sect3">
+<h4 id="website-logging-parent-rationale"><a class="anchor"
href="#website-logging-parent-rationale"></a>Rationale</h4>
+<div class="paragraph">
+<p>This branching scheme allows to</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>host multiple websites in a single repository</p>
+</li>
+<li>
+<p>deploy staging websites of multiple releases in parallel</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="website-log4j"><a class="anchor" href="#website-log4j"></a>Example:
Log4j website branching scheme</h3>
+<div class="paragraph">
+<p>For instance, the following branching scheme is used for the Log4j
project:</p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<caption class="title">Table 1. Log4j branching scheme for website
deployments</caption>
+<colgroup>
+<col style="width: 46.6666%;">
+<col style="width: 26.6666%;">
+<col style="width: 26.6668%;">
+</colgroup>
+<tbody>
+<tr>
+<th class="tableblock halign-center valign-middle" rowspan="2"><p
class="tableblock">Description</p></th>
+<th class="tableblock halign-center valign-top" colspan="2"><p
class="tableblock">Branch name</p></th>
+</tr>
+<tr>
+<th class="tableblock halign-center valign-top"><p class="tableblock">Log4j
2</p></th>
+<th class="tableblock halign-center valign-top"><p class="tableblock">Log4j
3</p></th>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Staging
website sources</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>2.x</code></p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>main</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Staging
website contents</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>2.x-site-stg-out</code></p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>main-site-stg-out</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Production
website sources</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>2.x-site-pro</code></p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>main-site-pro</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Production
website contents</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>2.x-site-pro-out</code></p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock"><code>main-site-pro-out</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Release
staging website sources</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><p
class="tableblock"><code>release/<version></code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Release
staging website contents</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><p
class="tableblock"><code>release/<version>-site-stg-out</code></p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+</article>
+ </div>
+</main>
+</div>
+<footer class="footer">
+ <p>
+ Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache
Software Foundation</a>.
+ Licensed under the <a
href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>.
+ Please read our <a
href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy
policy</a>.
+ </p>
+ <p>
+ Apache, Log4j, and the Apache feather logo are trademarks or registered
trademarks of The Apache Software Foundation.
+ Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ Other names may be trademarks of their respective owners.
+ </p>
+</footer>
+<script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script>
+<script async src="./_/js/vendor/highlight.js"></script>
+<!-- `@asciidoctor/tabs` extension scripts -->
+<script async src="./_/js/vendor/tabs.js"></script>
+ </body>
+</html>