Merge tag 'rel/1.5.0' into main-site-pro

1.5.0

.asf.yaml

@@ -50,6 +50,13 @@ github:
 
   del_branch_on_merge: true
 
+  # Enforce squashing while merging PRs.
+  # Otherwise, the git log gets polluted severely.
+  enabled_merge_buttons:
+    squash:  true
+    merge:   false
+    rebase:  false
+
   features:
     issues: true
 

.github/workflows/deploy-site.yaml

@@ -46,6 +46,7 @@ jobs:
           profile: ~
           whoami: ${{ github.ref_name }}-site-stg-out
           subdir: content/log4j/kotlin
+      install-required: true
       target-branch: ${{ github.ref_name }}-site-stg-out
 
   deploy-site-pro:
@@ -63,6 +64,7 @@ jobs:
           profile: ~
           whoami: ${{ github.ref_name }}-out
           subdir: content/log4j/kotlin
+      install-required: true
       target-branch: ${{ github.ref_name }}-out
 
   export-version:
@@ -92,4 +94,5 @@ jobs:
           profile: ~
           whoami: ${{ github.ref_name }}-site-stg-out
           subdir: content/log4j/kotlin-${{ needs.export-version.outputs.version }}
+      install-required: true
       target-branch: ${{ github.ref_name }}-site-stg-out

log4j-api-kotlin-benchmark/pom.xml

@@ -28,13 +28,14 @@
 
   <artifactId>log4j-api-kotlin-benchmark</artifactId>
 
+  <name>Apache Log4j Kotlin API benchmarks</name>
+
   <properties>
     <bnd.baseline.skip>true</bnd.baseline.skip>
     <maven.test.skip>true</maven.test.skip>
     <maven.deploy.skip>true</maven.deploy.skip>
     <maven.install.skip>true</maven.install.skip>
     <spotbugs.skip>true</spotbugs.skip>
-    <jmh.generator>default</jmh.generator>
     <uberjar.name>benchmarks</uberjar.name>
   </properties>
 
@@ -77,19 +78,28 @@
   </dependencies>
 
   <build>
+
     <plugins>
 
-      <!-- Compile Kotlin sources first -->
+      <!-- What follows is an unconventional plugin sequence to make JMH work with Kotlin.
+           The follow logic can be summarized as follows:
+
+           1. Compile JMH-annotated Kotlin sources
+           2. Using compiled (and JMH-annotated!) classes, generate JMH Java sources
+           3. Add JMH Java sources
+           4. Compile JMH Java sources -->
+
+      <!-- 1. Compile Kotlin sources -->
       <plugin>
         <groupId>org.jetbrains.kotlin</groupId>
         <artifactId>kotlin-maven-plugin</artifactId>
         <executions>
           <execution>
-            <id>process-sources</id>
+            <id>compile</id>
             <goals>
               <goal>compile</goal>
             </goals>
-            <phase>generate-sources</phase>
+            <phase>process-sources</phase>
             <configuration>
               <sourceDirs>
                 <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
@@ -99,7 +109,7 @@
         </executions>
       </plugin>
 
-      <!-- Invoke JMH generators to produce benchmark code -->
+      <!-- 2. Generate JMH sources -->
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>exec-maven-plugin</artifactId>
@@ -112,45 +122,48 @@
         </dependencies>
         <executions>
           <execution>
+            <id>generate-JMH-sources</id>
             <goals>
               <goal>java</goal>
             </goals>
-            <phase>generate-resources</phase>
+            <phase>process-resources</phase>
             <configuration>
               <includePluginDependencies>true</includePluginDependencies>
               <mainClass>org.openjdk.jmh.generators.bytecode.JmhBytecodeGenerator</mainClass>
               <arguments>
-                <argument>${project.basedir}/target/classes/</argument>
-                <argument>${project.basedir}/target/generated-sources/jmh/</argument>
-                <argument>${project.basedir}/target/classes/</argument>
-                <argument>${jmh.generator}</argument>
+                <!-- `compiled-bytecode-dir`: -->
+                <argument>${project.build.directory}/classes</argument>
+                <!-- `output-source-dir`: -->
+                <argument>${project.build.directory}/generated-sources/jmh</argument>
+                <!-- `output-resource-dir`: -->
+                <argument>${project.build.directory}/classes</argument>
               </arguments>
             </configuration>
           </execution>
         </executions>
       </plugin>
 
-      <!-- Add JMH generated code to the compile session -->
+      <!-- 3. Add generated JMH sources to the compile session -->
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>build-helper-maven-plugin</artifactId>
         <executions>
           <execution>
-            <id>add-source</id>
+            <id>add-JMH-sources</id>
             <goals>
               <goal>add-source</goal>
             </goals>
             <phase>process-resources</phase>
             <configuration>
               <sources>
-                <source>${project.basedir}/target/generated-sources/jmh</source>
+                <source>${project.build.directory}/generated-sources/jmh</source>
               </sources>
             </configuration>
           </execution>
         </executions>
       </plugin>
 
-      <!-- Compile JMH generated code -->
+      <!-- 4. Compile sources (incl. JMH-generated ones) -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
@@ -167,6 +180,7 @@
             </goals>
             <phase>package</phase>
             <configuration>
+              <createDependencyReducedPom>false</createDependencyReducedPom>
               <finalName>${uberjar.name}</finalName>
               <transformers>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">

pom.xml

@@ -125,7 +125,7 @@
   <properties>
 
     <!-- project version -->
-    <revision>1.5.0-SNAPSHOT</revision>
+    <revision>1.5.0</revision>
 
     <!-- `project.build.outputTimestamp` is required to be present for reproducible builds.
          We actually inherit one from the `org.apache:apache` through our parent `org.apache.logging:logging-parent`.
@@ -134,7 +134,7 @@
          2. This value is employed in various places while creating the distribution
          To mitigate these, we define a *dummy* value here and let the CI replace it during a release.
          Hence, *DO NOT MANUALLY EDIT THIS VALUE*! -->
-    <project.build.outputTimestamp>2023-12-18T18:39:10Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2024-08-03T16:55:56Z</project.build.outputTimestamp>
 
     <!-- disable `maven-site-plugin`-->
     <maven.site.skip>true</maven.site.skip>

src/changelog/1.5.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 release contains improvements to Kotlin coroutine integration.
+
+<#include "../.changelog.adoc.ftl">

src/changelog/1.5.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="https://logging.apache.org/xml/ns"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+         date="2024-08-03" version="1.5.0"/>