Merge branch 'release/1.3.0'
diff --git a/.github/generate-email.sh b/.github/generate-email.sh
index f90e0fa..f30d9eb 100755
--- a/.github/generate-email.sh
+++ b/.github/generate-email.sh
@@ -34,6 +34,7 @@
# Constants
PROJECT_NAME="Apache Log4j Kotlin API"
PROJECT_SITE="https://logging.apache.org/log4j/kotlin"
+PROJECT_STAGING_SITE="${PROJECT_SITE/apache.org/staged.apache.org}"
PROJECT_REPO="https://github.com/apache/logging-log4j-kotlin"
PROJECT_DIST_DIR="https://dist.apache.org/repos/dist/dev/logging/log4j-kotlin"
PROJECT_VERSION="$2"
@@ -59,7 +60,8 @@
This is a vote to release the $PROJECT_NAME $PROJECT_VERSION.
-Source repository: $PROJECT_REPO
+Website: $PROJECT_STAGING_SITE
+GitHub: $PROJECT_REPO
Commit: $COMMIT_ID
Distribution: $PROJECT_DIST_DIR
Nexus: https://repository.apache.org/content/repositories/orgapachelogging-1113
diff --git a/README.adoc b/README.adoc
index dd1af03..3386eca 100644
--- a/README.adoc
+++ b/README.adoc
@@ -15,7 +15,7 @@
limitations under the License.
////
-https://github.com/apache/logging-log4j-kotlin/actions[image:https://github.com/apache/logging-log4j-kotlin/workflows/build/badge.svg[Actions Status]]
+https://github.com/apache/logging-log4j-kotlin/actions[image:https://github.com/apache/logging-log4j-kotlin/actions/workflows/build.yaml/badge.svg[Actions Status]]
https://search.maven.org/search?q=g:org.apache.logging.log4j%20a:log4j-api-kotlin-parent[image:https://img.shields.io/maven-central/v/org.apache.logging.log4j/log4j-api-kotlin-parent.svg[Maven Central]]
https://www.apache.org/licenses/LICENSE-2.0.txt[image:https://img.shields.io/github/license/apache/logging-log4j-kotlin.svg[License]]
diff --git a/log4j-api-kotlin-benchmark/pom.xml b/log4j-api-kotlin-benchmark/pom.xml
index 399fe71..ba0bb26 100644
--- a/log4j-api-kotlin-benchmark/pom.xml
+++ b/log4j-api-kotlin-benchmark/pom.xml
@@ -29,6 +29,7 @@
<artifactId>log4j-api-kotlin-benchmark</artifactId>
<properties>
+ <maven.deploy.skip>true</maven.deploy.skip>
<spotbugs.skip>true</spotbugs.skip>
<jmh.generator>default</jmh.generator>
<uberjar.name>benchmarks</uberjar.name>
diff --git a/log4j-api-kotlin-sample/pom.xml b/log4j-api-kotlin-sample/pom.xml
index 763c06f..1c120c1 100644
--- a/log4j-api-kotlin-sample/pom.xml
+++ b/log4j-api-kotlin-sample/pom.xml
@@ -31,6 +31,10 @@
<name>Apache Log4j Kotlin API samples</name>
<description>Sample usage of the Log4j Kotlin API</description>
+ <properties>
+ <maven.deploy.skip>true</maven.deploy.skip>
+ </properties>
+
<dependencies>
<dependency>
diff --git a/log4j-api-kotlin/pom.xml b/log4j-api-kotlin/pom.xml
index b4ee326..529476d 100644
--- a/log4j-api-kotlin/pom.xml
+++ b/log4j-api-kotlin/pom.xml
@@ -35,7 +35,6 @@
<!--
~ OSGi and JPMS configuration
-->
- <bnd-module-name>org.apache.logging.log4j.kotlin</bnd-module-name>
<bnd-extra-package-options>
<!-- Optional packages -->
kotlin.reflect.*;resolution:=optional,
@@ -43,7 +42,6 @@
</bnd-extra-package-options>
<bnd-extra-module-options>
<!-- BND does not look in META-INF/versions/9 for a module descriptor -->
- org.apache.logging.log4j;substitute="log4j-api",
kotlin.stdlib;substitute="kotlin-stdlib",
kotlin.reflect;substitute="kotlin-reflect",
<!-- Module name from version 1.7.x, version 1.6.x has no name -->
diff --git a/pom.xml b/pom.xml
index d9d27e2..3fbaad7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,7 +22,7 @@
<parent>
<groupId>org.apache.logging</groupId>
<artifactId>logging-parent</artifactId>
- <version>10.1.0</version>
+ <version>10.1.1</version>
<relativePath />
</parent>
@@ -121,7 +121,7 @@
<properties>
<!-- project version -->
- <revision>1.3.0-SNAPSHOT</revision>
+ <revision>1.3.0</revision>
<!-- disable `maven-site-plugin`-->
<maven.site.skip>true</maven.site.skip>
@@ -239,12 +239,6 @@
</plugin>
<plugin>
- <groupId>org.jetbrains.dokka</groupId>
- <artifactId>dokka-maven-plugin</artifactId>
- <version>${dokka.plugin.version}</version>
- </plugin>
-
- <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>${maven-shade-plugin.version}</version>
diff --git a/src/changelog/1.3.0/.release-notes.adoc.ftl b/src/changelog/1.3.0/.release-notes.adoc.ftl
new file mode 100644
index 0000000..a0d914e
--- /dev/null
+++ b/src/changelog/1.3.0/.release-notes.adoc.ftl
@@ -0,0 +1,43 @@
+////
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+////
+
+////
+ ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██
+ ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██
+ ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
+ ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
+
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
+
+ Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`.
+ Auto-generation happens during `generate-sources` phase of Maven.
+ Hence, you must always
+
+ 1. Find and edit the associated `.release-notes.adoc.ftl`
+ 2. Run `./mvnw generate-sources`
+ 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
+////
+
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+=== ${release.version}
+
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+
+This minor release bumps the Kotlin baseline to 1.6.21 and contains various small improvements.
+
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/1.3.0/.release.xml b/src/changelog/1.3.0/.release.xml
new file mode 100644
index 0000000..ea97f94
--- /dev/null
+++ b/src/changelog/1.3.0/.release.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to you under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+<release xmlns="http://logging.apache.org/log4j/changelog"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.0.xsd"
+ date="2023-10-03" version="1.3.0"/>
diff --git a/src/changelog/.1.x.x/28-Update_Log4j_baseline.xml b/src/changelog/1.3.0/28-Update_Log4j_baseline.xml
similarity index 100%
rename from src/changelog/.1.x.x/28-Update_Log4j_baseline.xml
rename to src/changelog/1.3.0/28-Update_Log4j_baseline.xml
diff --git a/src/changelog/.1.x.x/29-Add_extension_property_for_logger.xml b/src/changelog/1.3.0/29-Add_extension_property_for_logger.xml
similarity index 100%
rename from src/changelog/.1.x.x/29-Add_extension_property_for_logger.xml
rename to src/changelog/1.3.0/29-Add_extension_property_for_logger.xml
diff --git a/src/changelog/.1.x.x/30-Add_facade_APIs_for_ThreadContext.xml b/src/changelog/1.3.0/30-Add_facade_APIs_for_ThreadContext.xml
similarity index 100%
rename from src/changelog/.1.x.x/30-Add_facade_APIs_for_ThreadContext.xml
rename to src/changelog/1.3.0/30-Add_facade_APIs_for_ThreadContext.xml
diff --git a/src/changelog/.1.x.x/32-Catching_Throwing.xml b/src/changelog/1.3.0/32-Catching_Throwing.xml
similarity index 100%
rename from src/changelog/.1.x.x/32-Catching_Throwing.xml
rename to src/changelog/1.3.0/32-Catching_Throwing.xml
diff --git a/src/changelog/.1.x.x/37-facelift.xml b/src/changelog/1.3.0/37-facelift.xml
similarity index 88%
rename from src/changelog/.1.x.x/37-facelift.xml
rename to src/changelog/1.3.0/37-facelift.xml
index 911ce1a..98a2399 100644
--- a/src/changelog/.1.x.x/37-facelift.xml
+++ b/src/changelog/1.3.0/37-facelift.xml
@@ -4,5 +4,5 @@
type="changed">
<issue id="37" link="https://github.com/apache/logging-log4j-kotlin/pull/37"/>
<author id="github:vy"/>
- <description format="asciidoc">Bumped `logging-parent` version to `10.1.0` and overhauled the entire project infrastructure to take advantage of its goodies</description>
+ <description format="asciidoc">Bumped `logging-parent` version to `10.1.1` and overhauled the entire project infrastructure to take advantage of its goodies</description>
</entry>
diff --git a/src/changelog/.1.x.x/JPMS.xml b/src/changelog/1.3.0/JPMS.xml
similarity index 71%
rename from src/changelog/.1.x.x/JPMS.xml
rename to src/changelog/1.3.0/JPMS.xml
index 93a96ec..d3c2269 100644
--- a/src/changelog/.1.x.x/JPMS.xml
+++ b/src/changelog/1.3.0/JPMS.xml
@@ -3,5 +3,5 @@
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
type="added">
<author id="github:vy"/>
- <description format="asciidoc">Added JPMS support and used `org.apache.logging.log4j.kotlin` for the module name.</description>
+ <description format="asciidoc">Added JPMS support and used `org.apache.logging.log4j.api.kotlin` for the module name (identical to OSGi `Bundle-SymbolicName`) of the `log4j-api-kotlin` artifact</description>
</entry>
diff --git a/src/changelog/.1.x.x/OSGi-Bundle-SymbolicName.xml b/src/changelog/1.3.0/OSGi-Bundle-SymbolicName.xml
similarity index 92%
rename from src/changelog/.1.x.x/OSGi-Bundle-SymbolicName.xml
rename to src/changelog/1.3.0/OSGi-Bundle-SymbolicName.xml
index 5aad7e9..0159c53 100644
--- a/src/changelog/.1.x.x/OSGi-Bundle-SymbolicName.xml
+++ b/src/changelog/1.3.0/OSGi-Bundle-SymbolicName.xml
@@ -3,5 +3,5 @@
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
type="changed">
<author id="github:vy"/>
- <description format="asciidoc">Renamed OSGi `Bundle-SymbolicName` from `org.apache.logging.log4j.kotlin` to `org.apache.logging.log4j.api_kotlin`</description>
+ <description format="asciidoc">Renamed OSGi `Bundle-SymbolicName` from `org.apache.logging.log4j.kotlin` to `org.apache.logging.log4j.api.kotlin`</description>
</entry>
diff --git a/src/changelog/.1.x.x/JPMS.xml b/src/changelog/1.3.0/dokka.xml
similarity index 64%
copy from src/changelog/.1.x.x/JPMS.xml
copy to src/changelog/1.3.0/dokka.xml
index 93a96ec..a53340b 100644
--- a/src/changelog/.1.x.x/JPMS.xml
+++ b/src/changelog/1.3.0/dokka.xml
@@ -1,7 +1,7 @@
<entry xmlns="http://logging.apache.org/log4j/changelog"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
- type="added">
+ type="removed">
<author id="github:vy"/>
- <description format="asciidoc">Added JPMS support and used `org.apache.logging.log4j.kotlin` for the module name.</description>
+ <description format="asciidoc">Stopped exporting KDoc to HTML</description>
</entry>
diff --git a/src/changelog/.1.x.x/junit5.xml b/src/changelog/1.3.0/junit5.xml
similarity index 100%
rename from src/changelog/.1.x.x/junit5.xml
rename to src/changelog/1.3.0/junit5.xml
diff --git a/src/changelog/.1.x.x/kotlin-baseline.xml b/src/changelog/1.3.0/kotlin-baseline.xml
similarity index 100%
rename from src/changelog/.1.x.x/kotlin-baseline.xml
rename to src/changelog/1.3.0/kotlin-baseline.xml
diff --git a/src/changelog/.1.x.x/OSGi-Bundle-SymbolicName.xml b/src/changelog/1.3.0/skip-deploy.xml
similarity index 64%
copy from src/changelog/.1.x.x/OSGi-Bundle-SymbolicName.xml
copy to src/changelog/1.3.0/skip-deploy.xml
index 5aad7e9..3b0e5f4 100644
--- a/src/changelog/.1.x.x/OSGi-Bundle-SymbolicName.xml
+++ b/src/changelog/1.3.0/skip-deploy.xml
@@ -3,5 +3,5 @@
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
type="changed">
<author id="github:vy"/>
- <description format="asciidoc">Renamed OSGi `Bundle-SymbolicName` from `org.apache.logging.log4j.kotlin` to `org.apache.logging.log4j.api_kotlin`</description>
+ <description format="asciidoc">Skipped deploying `log4j-api-kotlin-benchmark` and `log4j-api-kotlin-sample` modules</description>
</entry>
diff --git a/src/site/_constants.adoc b/src/site/_constants.adoc
index ee24a71..ee069db 100644
--- a/src/site/_constants.adoc
+++ b/src/site/_constants.adoc
@@ -34,7 +34,7 @@
////
:project-github-url: https://github.com/apache/logging-log4j-kotlin
-:project-version: 1.3.0-SNAPSHOT
+:project-version: 1.3.0
:project-name: Log4j Kotlin API
:project-id: log4j-kotlin
:java-target-version: 8
diff --git a/src/site/_release-notes.adoc b/src/site/_release-notes.adoc
index 6fbed8f..04a78f0 100644
--- a/src/site/_release-notes.adoc
+++ b/src/site/_release-notes.adoc
@@ -36,7 +36,7 @@
[#release-notes]
== Release Notes
-include::_release-notes/_1.x.x.adoc[]
+include::_release-notes/_1.3.0.adoc[]
include::_release-notes/_1.2.0.adoc[]
include::_release-notes/_1.1.0.adoc[]
include::_release-notes/_1.0.0.adoc[]
diff --git a/src/site/_release-notes/_1.3.0.adoc b/src/site/_release-notes/_1.3.0.adoc
new file mode 100644
index 0000000..721ecdc
--- /dev/null
+++ b/src/site/_release-notes/_1.3.0.adoc
@@ -0,0 +1,62 @@
+////
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+////
+
+////
+ ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██
+ ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██
+ ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
+ ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
+ ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
+
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
+
+ Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`.
+ Auto-generation happens during `generate-sources` phase of Maven.
+ Hence, you must always
+
+ 1. Find and edit the associated `.release-notes.adoc.ftl`
+ 2. Run `./mvnw generate-sources`
+ 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
+////
+
+[#release-notes-1-3-0]
+=== 1.3.0
+
+Release date:: 2023-10-03
+
+This minor release bumps the Kotlin baseline to 1.6.21 and contains various small improvements.
+
+
+==== Added
+
+* Added an extension property for storing a cached logger (https://github.com/apache/logging-log4j-kotlin/issues/29[29])
+* Added facade APIs for manipulating the context map and stack (https://github.com/apache/logging-log4j-kotlin/issues/30[30])
+* Added missing `catching` and `throwing` API methods in `KotlinLogger` (https://github.com/apache/logging-log4j-kotlin/issues/32[32])
+* Added JPMS support and used `org.apache.logging.log4j.api.kotlin` for the module name (identical to OSGi `Bundle-SymbolicName`) of the `log4j-api-kotlin` artifact
+
+==== Changed
+
+* Updated Log4j dependency to `2.20.0`
+* Bumped `logging-parent` version to `10.1.1` and overhauled the entire project infrastructure to take advantage of its goodies (https://github.com/apache/logging-log4j-kotlin/pull/37[37])
+* Renamed OSGi `Bundle-SymbolicName` from `org.apache.logging.log4j.kotlin` to `org.apache.logging.log4j.api.kotlin`
+* Migrated tests to JUnit 5
+* Bumped Kotlin and Kotlin Extensions baseline to `1.6.21` and `1.6.4` respectively
+* Skipped deploying `log4j-api-kotlin-benchmark` and `log4j-api-kotlin-sample` modules
+
+==== Removed
+
+* Stopped exporting KDoc to HTML
diff --git a/src/site/_release-notes/_1.x.x.adoc b/src/site/_release-notes/_1.x.x.adoc
index 151f5b7..cc4cccf 100644
--- a/src/site/_release-notes/_1.x.x.adoc
+++ b/src/site/_release-notes/_1.x.x.adoc
@@ -40,18 +40,3 @@
This minor release bumps the Kotlin baseline to 1.6.21 and contains various small improvements.
-
-==== Added
-
-* Added an extension property for storing a cached logger (https://github.com/apache/logging-log4j-kotlin/issues/29[29])
-* Added facade APIs for manipulating the context map and stack (https://github.com/apache/logging-log4j-kotlin/issues/30[30])
-* Added missing `catching` and `throwing` API methods in `KotlinLogger` (https://github.com/apache/logging-log4j-kotlin/issues/32[32])
-* Added JPMS support and used `org.apache.logging.log4j.api_kotlin` for the module name (identical to OSGi `Bundle-SymbolicName`) of the `log4j-api-kotlin` artifact
-
-==== Changed
-
-* Updated Log4j dependency to `2.20.0`
-* Bumped `logging-parent` version to `10.1.0` and overhauled the entire project infrastructure to take advantage of its goodies (https://github.com/apache/logging-log4j-kotlin/pull/37[37])
-* Renamed OSGi `Bundle-SymbolicName` from `org.apache.logging.log4j.kotlin` to `org.apache.logging.log4j.api_kotlin`
-* Migrated tests to JUnit 5
-* Bumped Kotlin and Kotlin Extensions baseline to `1.6.21` and `1.6.4` respectively
diff --git a/src/site/index.adoc b/src/site/index.adoc
index aa8be56..4c821ca 100644
--- a/src/site/index.adoc
+++ b/src/site/index.adoc
@@ -44,7 +44,7 @@
</dependency>
----
-Java module name and OSGi `Bundle-SymbolicName` are set to `org.apache.logging.log4j.api_kotlin`.
+Java module name and OSGi `Bundle-SymbolicName` are set to `org.apache.logging.log4j.api.kotlin`.
[#usage]
== Usage
