Adapt changes for `logging-parent` version `10.1.0-SNAPSHOT`
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index c2db415..f7531e4 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -22,7 +22,7 @@
# Avoid workflow run for _merged_ `dependabot` PRs.
# They were (hopefully!) already tested in PR-triggered workflow.
branches-ignore:
- - "dependabot/**"
+ - "dependabot/**"
paths-ignore:
- "**.adoc"
- "**.md"
@@ -43,23 +43,26 @@
permissions:
contents: write
pull-requests: write
+ # Secrets for signing commits
+ secrets: inherit
deploy-snapshot:
needs: build
- if: github.repository == 'apache/logging-log4j-kotlin' && github.ref == 'refs/heads/main'
+ if: github.repository == 'apache/logging-parent' && github.ref == 'refs/heads/main'
uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@main
+ # Secrets for deployments
secrets: inherit
deploy-release:
needs: build
- if: github.repository == 'apache/logging-log4j-kotlin' && startsWith(github.ref, 'refs/heads/release/')
+ if: github.repository == 'apache/logging-parent' && startsWith(github.ref, 'refs/heads/release/')
uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@main
+ # Secrets for deployments
secrets: inherit
# Write permissions to allow the Maven `revision` property update, changelog release, etc.
permissions:
contents: write
with:
- project-name: log4j-kotlin
- distribution-attachment-count: 1
- distribution-attachment-filepath-pattern: |-
- '^.*/target/log4j-api-kotlin-'${PROJECT_VERSION}'\\.jar$'
+ project-id: logging-parent
+ distribution-attachment-count: 0
+ site-enabled: true
diff --git a/.mvn/jvm.config b/.mvn/jvm.config
index 6f7d1c8..45a0340 100644
--- a/.mvn/jvm.config
+++ b/.mvn/jvm.config
@@ -9,3 +9,5 @@
--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED
+--add-opens java.base/sun.nio.ch=ALL-UNNAMED
+--add-opens java.base/java.io=ALL-UNNAMED
diff --git a/README.adoc b/README.adoc
index b68618e..a1d705d 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,18 +1,18 @@
////
-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
+ 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
- https://www.apache.org/licenses/LICENSE-2.0
+ https://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.
+ 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.
////
https://github.com/apache/logging-log4j-kotlin/actions[image:https://github.com/apache/logging-log4j-kotlin/workflows/build/badge.svg[Actions Status]]
@@ -20,52 +20,7 @@
https://www.apache.org/licenses/LICENSE-2.0.txt[image:https://img.shields.io/github/license/apache/logging-log4j-kotlin.svg[License]]
:log4j-url: https://logging.apache.org/log4j/2.x
+:log4j-kotlin-url: https://logging.apache.org/log4j/kotlin
:log4j-api-url: {log4j-url}/manual/api-separation.html
-Log4j Kotlin API provides a Kotlin-friendly interface to log against {log4j-api-url}[the Log4j API].
-The minimum requirements are Java 8 and Kotlin 1.3.
-
-[IMPORTANT]
-====
-This is just a logging API.
-Your application still needs to have a logging backend (e.g., {log4j-url}[Log4j]) configured.
-====
-
-== Usage
-
-See xref:doc/manual.adoc[the manual].
-
-== Build
-
-This project generates Java 8 bytecode, though requires Java 17 for compilation.
-You can build and test sources using `./mvnw verify` command.
-
-== Distribution
-
-In accordance with the Apache Software Foundation's release https://infra.apache.org/release-distribution.html[distribution policy] and https://infra.apache.org/release-publishing.html[creation process], project artifacts are _officially_ accessible from the following locations:
-
-* ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository])
-* ASF https://downloads.apache.org/logging/log4j-kotlin[Distribution directory]
-
-See xref:RELEASING.adoc[release instructions] for further details.
-
-== Support
-
-Please keep in mind that this project is intended for internal usage only.
-You can use GitHub Issues for feature requests and bug reports – not questions!
-See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details.
-
-== Security
-
-If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:security@logging.apache.org[the Log4j security mailing list].
-See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details.
-
-== License
-
-Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
-See xref:NOTICE.txt[] 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 https://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.
+Log4j Kotlin API provides a Kotlin-friendly interface to log against {log4j-api-url}[the Log4j API]. See {log4j-kotlin-url}[the project website] for more information.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
deleted file mode 100644
index a37d693..0000000
--- a/RELEASE-NOTES.md
+++ /dev/null
@@ -1,22 +0,0 @@
-<!--
- ~ 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.
- -->
-
-This project uses itself, i.e., `log4j-changelog-maven-plugin`, for keeping a changelog and generating release notes.
-
-Changelog files are located under [`src/changelog`](src/changelog).
-Release notes can be generated using `./mvnw -N -P changelog-export` command.
-See [`log4j-changelog-maven-plugin`](log4j-changelog-maven-plugin) for details on how it all works.
diff --git a/RELEASING.adoc b/RELEASING.adoc
deleted file mode 100644
index bfde00b..0000000
--- a/RELEASING.adoc
+++ /dev/null
@@ -1,143 +0,0 @@
-////
-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
-
- https://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.
-////
-
-// ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██
-// ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██
-// ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
-// ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
-// ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
-//
-// Below instructions are shared by all Maven-based Apache Logging Services projects.
-// Be extremely cautious while making changes!
-
-// Configuration ///////////////////////////////////////////////////////////////
-
-// Name of the GitHub repository; `logging-parent`, `logging-log4j2`, `logging-log4j-tools`, etc.
-:repository-name: logging-log4j-kotlin
-
-// Name of the project; `logging-parent`, `log4j`, `log4j-tools`
-:project-name: log4j-kotlin
-
-// Instructions ////////////////////////////////////////////////////////////////
-
-= Release instructions
-
-[WARNING]
-====
-In the code examples below, assuming the version to be released is `7.8.0`.
-====
-
-== Stage the release
-
-. Create and push the release branch:
-+
-[source,bash]
-----
-git fetch -p
-git checkout -B release/7.8.0 origin/main
-git push origin release/7.8.0
-----
-. Verify that the associated https://github.com/apache/{repository-name}/actions[GitHub Actions workflow] succeeds:
-.. `revision` property in `pom.xml` is updated
-.. Changelog is released (i.e., `src/changelog/7.8.0` folder is populated)
-.. *Signed artifacts* are uploaded to the _Staging Repositories_ in https://repository.apache.org/[repository.apache.org]
-.. *Signed distribution and its checksum* (e.g., `apache-{project-name}-7.8.0-{bin,src}.{zip,.zip.asc,.zip.sha512}`) are uploaded to https://dist.apache.org/repos/dist/dev/logging/log4j[dist.apache.org/repos/dist/**dev**/logging/log4j] Subversion repository (along with auxiliary files; email texts, etc.)
-
-+
-If not, commit necessary fixes, push, and repeat.
-
-+
-[TIP]
-====
-GitHub Actions workflow is idempotent.
-You can iterate on the `release/7.8.0` branch to perfect it.
-====
-. _Close_ the repository in https://repository.apache.org/[repository.apache.org]
-
-== Vote the release
-
-. Send the vote email uploaded to the https://dist.apache.org/repos/dist/dev/logging/log4j[dist.apache.org/repos/dist/**dev**/logging/log4j] Subversion repository
-+
-[WARNING]
-====
-**Fix the cited https://repository.apache.org[repository.apache.org] URL** in the generated email!
-It changes after every Nexus deployment.
-====
-+
-[WARNING]
-====
-Make sure your email is sent in plain text, that is, https://infra.apache.org/contrib-email-tips#nohtml[no HTML]!
-If you are using GMail, simply enable the _"Plain text mode"_ while composing your message.
-====
-
-. Once the consensus is reached within the set time frame, respond to the first post in the thread as follows:
-+
-[source]
-----
-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.
-----
-
-== Publish the release
-
-=== In the git repository
-
-. Pull the most recent changes and tags
-. Tag the release (e.g., `rel/7.8.0`) and push it
-+
-[source,bash]
-----
-git tag -a rel/7.8.0 <COMMIT-ID> -m 7.8.0
-git push origin rel/7.8.0
-----
-+
-[IMPORTANT]
-====
-The ASF infrastructure treats ``rel/``-prefixed git tags special and ensures they are immutable for provenance reasons.
-====
-. Merge `release/7.8.0` to `main`
-. Set the revision property to the next development version (e.g., `7.9.0-SNAPSHOT`) in xref:pom.xml[`pom.xml`]
-. Commit changes and push the `main` branch
-. Delete the local and remote copies of the `release/7.8.0` branch
-
-=== In the ASF infrastructure
-
-. _Release_ the repository in https://repository.apache.org[repository.apache.org]
-. In https://dist.apache.org/repos/dist/release/logging/{project-name}[dist.apache.org/repos/dist] Subversion repository,
-.. create the `*release*/logging/{project-name}/7.8.0` folder, and copy the signed sources and their checksum from `*dev*/logging/{project-name}` to there
-.. delete the folder from an earlier release in `*release*/logging/{project-name}`
-.. commit changes
-. Report the release at https://reporter.apache.org/[reporter.apache.org]
-
-=== In GitHub
-
-Once the artifacts are visible in https://central.sonatype.dev/[central.sonatype.dev], https://github.com/apache/{repository-name}/releases/new[create a new release in GitHub]
-
-. Use the `rel/7.8.0` tag
-. Copy release notes from the generated emails
-
-== Announce the release
-
-. Send the announcement email uploaded to the https://dist.apache.org/repos/dist/dev/logging/{project-name}[dist.apache.org/repos/dist/**dev**/logging/{project-name}] Subversion repository
-+
-[WARNING]
-====
-Make sure your email is sent in plain text, that is, https://infra.apache.org/contrib-email-tips#nohtml[no HTML]!
-If you are using GMail, simply enable the _"Plain text mode"_ while composing your message.
-====
diff --git a/pom.xml b/pom.xml
index 27950df..c79d51f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,7 +22,7 @@
<parent>
<groupId>org.apache.logging</groupId>
<artifactId>logging-parent</artifactId>
- <version>10.0.0</version>
+ <version>10.1.0-SNAPSHOT</version>
<relativePath />
</parent>
@@ -123,6 +123,10 @@
<!-- project version -->
<revision>1.3.0-SNAPSHOT</revision>
+ <!-- disable `maven-site-plugin`-->
+ <maven.site.skip>true</maven.site.skip>
+ <maven.site.deploy.skip>true</maven.site.deploy.skip>
+
<!-- dependency versions -->
<jmh.version>1.37</jmh.version>
<junit.version>5.10.0</junit.version>
@@ -302,75 +306,4 @@
</build>
- <profiles>
-
- <!-- populate `doc/maven-properties.adoc` from `doc/maven-properties.tmpl.adoc` -->
- <profile>
-
- <id>maven-properties-adoc</id>
-
- <activation>
- <file>
- <exists>doc/maven-properties.tmpl.adoc</exists>
- </file>
- </activation>
-
- <build>
- <plugins>
-
- <!-- copy `doc/maven-properties.tmpl.adoc` to `target/doc` -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-antrun-plugin</artifactId>
- <executions>
- <execution>
- <id>copy-doc-maven-properties-tmpl</id>
- <goals>
- <goal>run</goal>
- </goals>
- <phase>generate-sources</phase>
- <inherited>false</inherited>
- <configuration>
- <target>
- <copy overwrite="true" tofile="${project.build.directory}/doc/maven-properties.adoc" verbose="true">
- <fileset file="doc/maven-properties.tmpl.adoc" />
- </copy>
- </target>
- </configuration>
- </execution>
- </executions>
- </plugin>
-
- <!-- process `target/doc` and output to `doc` -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <executions>
- <execution>
- <id>filter-doc-maven-properties-tmpl</id>
- <goals>
- <goal>copy-resources</goal>
- </goals>
- <phase>process-sources</phase>
- <inherited>false</inherited>
- <configuration>
- <outputDirectory>doc</outputDirectory>
- <resources>
- <resource>
- <directory>${project.build.directory}/doc</directory>
- <filtering>true</filtering>
- </resource>
- </resources>
- </configuration>
- </execution>
- </executions>
- </plugin>
-
- </plugins>
- </build>
-
- </profile>
-
- </profiles>
-
</project>
diff --git a/doc/maven-properties.tmpl.adoc b/src/changelog/.1.x.x/.release-notes.adoc.ftl
similarity index 64%
copy from doc/maven-properties.tmpl.adoc
copy to src/changelog/.1.x.x/.release-notes.adoc.ftl
index 907c36c..a0d914e 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/changelog/.1.x.x/.release-notes.adoc.ftl
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,22 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#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.x.x/.release-notes.md.ftl b/src/changelog/.1.x.x/.release-notes.md.ftl
deleted file mode 100644
index 8e0b67d..0000000
--- a/src/changelog/.1.x.x/.release-notes.md.ftl
+++ /dev/null
@@ -1,22 +0,0 @@
-<#--
- ~ 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.version}<#if release.date?has_content> (${release.date})</#if>
-
-This minor release bumps the Kotlin baseline to 1.6.21 and contains various small improvements.
-
-<#include "../.changelog.md.ftl">
diff --git a/src/changelog/.1.x.x/28-Update_Log4j_baseline.xml b/src/changelog/.1.x.x/28-Update_Log4j_baseline.xml
index 6f511c7..0e420e3 100644
--- a/src/changelog/.1.x.x/28-Update_Log4j_baseline.xml
+++ b/src/changelog/.1.x.x/28-Update_Log4j_baseline.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="markdown">Updated Log4j dependency to `2.20.0`</description>
+ <description format="asciidoc">Updated Log4j dependency to `2.20.0`</description>
</entry>
diff --git a/src/changelog/.1.x.x/29-Add_extension_property_for_logger.xml b/src/changelog/.1.x.x/29-Add_extension_property_for_logger.xml
index e5bc7ef..7cd34be 100644
--- a/src/changelog/.1.x.x/29-Add_extension_property_for_logger.xml
+++ b/src/changelog/.1.x.x/29-Add_extension_property_for_logger.xml
@@ -4,5 +4,5 @@
type="added">
<issue id="29" link="https://github.com/apache/logging-log4j-kotlin/issues/29"/>
<author id="github:jvz"/>
- <description format="markdown">Added an extension property for storing a cached logger</description>
+ <description format="asciidoc">Added an extension property for storing a cached logger</description>
</entry>
diff --git a/src/changelog/.1.x.x/30-Add_facade_APIs_for_ThreadContext.xml b/src/changelog/.1.x.x/30-Add_facade_APIs_for_ThreadContext.xml
index 70dc135..d9d6fc8 100644
--- a/src/changelog/.1.x.x/30-Add_facade_APIs_for_ThreadContext.xml
+++ b/src/changelog/.1.x.x/30-Add_facade_APIs_for_ThreadContext.xml
@@ -4,5 +4,5 @@
type="added">
<issue id="30" link="https://github.com/apache/logging-log4j-kotlin/issues/30"/>
<author id="github:jvz"/>
- <description format="markdown">Added facade APIs for manipulating the context map and stack</description>
+ <description format="asciidoc">Added facade APIs for manipulating the context map and stack</description>
</entry>
diff --git a/src/changelog/.1.x.x/32-Catching_Throwing.xml b/src/changelog/.1.x.x/32-Catching_Throwing.xml
index 4ec026b..dd7f356 100644
--- a/src/changelog/.1.x.x/32-Catching_Throwing.xml
+++ b/src/changelog/.1.x.x/32-Catching_Throwing.xml
@@ -4,5 +4,5 @@
type="added">
<issue id="32" link="https://github.com/apache/logging-log4j-kotlin/issues/32"/>
<author id="github:rocketraman"/>
- <description format="markdown">Added missing `catching` and `throwing` API methods in `KotlinLogger`</description>
+ <description format="asciidoc">Added missing `catching` and `throwing` API methods in `KotlinLogger`</description>
</entry>
diff --git a/src/changelog/.1.x.x/37-facelift.xml b/src/changelog/.1.x.x/37-facelift.xml
index 3fd1f67..007fca0 100644
--- a/src/changelog/.1.x.x/37-facelift.xml
+++ b/src/changelog/.1.x.x/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="markdown">Bumped `logging-parent` version to `10.0.0` and overhauled the entire project infrastructure to take advantage of its goodies</description>
+ <description format="asciidoc">Bumped `logging-parent` version to `10.0.0` and overhauled the entire project infrastructure to take advantage of its goodies</description>
</entry>
diff --git a/src/changelog/.1.x.x/junit5.xml b/src/changelog/.1.x.x/junit5.xml
index 14ecce6..b92df76 100644
--- a/src/changelog/.1.x.x/junit5.xml
+++ b/src/changelog/.1.x.x/junit5.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="markdown">Migrated tests to JUnit 5</description>
+ <description format="asciidoc">Migrated tests to JUnit 5</description>
</entry>
diff --git a/src/changelog/.1.x.x/kotlin-baseline.xml b/src/changelog/.1.x.x/kotlin-baseline.xml
index 75c1bac..43ab1c6 100644
--- a/src/changelog/.1.x.x/kotlin-baseline.xml
+++ b/src/changelog/.1.x.x/kotlin-baseline.xml
@@ -4,5 +4,5 @@
type="changed">
<author id="github:breun"/>
<author id="github:vy"/>
- <description format="markdown">Bumped Kotlin and Kotlin Extensions baseline to `1.6.21` and `1.6.4` respectively</description>
+ <description format="asciidoc">Bumped Kotlin and Kotlin Extensions baseline to `1.6.21` and `1.6.4` respectively</description>
</entry>
diff --git a/src/changelog/.changelog.md.ftl b/src/changelog/.changelog.adoc.ftl
similarity index 76%
rename from src/changelog/.changelog.md.ftl
rename to src/changelog/.changelog.adoc.ftl
index b7012dd..ebd41f0 100644
--- a/src/changelog/.changelog.md.ftl
+++ b/src/changelog/.changelog.adoc.ftl
@@ -14,13 +14,13 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<#if entriesByType?size gt 0>## Changes
+<#if entriesByType?size gt 0>
<#list entriesByType as entryType, entries>
-### ${entryType?capitalize}
+==== ${entryType?capitalize}
<#list entries as entry>
-* ${entry.description.text?replace("\\s+", " ", "r")}<#if entry.issues?has_content> (<#list entry.issues as issue><#if issue.link?starts_with("https://github.com/apache/logging-log4j-kotlin")>#${issue.id}<#else>[${issue.id}](${issue.link})</#if><#if issue?has_next>, </#if></#list>)</#if>
+* ${entry.description.text?replace("\\s+", " ", "r")}<#if entry.issues?has_content> (<#list entry.issues as issue>${issue.link}[${issue.id}]<#if issue?has_next>, </#if></#list>)</#if>
</#list>
</#list>
</#if>
diff --git a/doc/maven-properties.tmpl.adoc b/src/changelog/.index.adoc.ftl
similarity index 75%
rename from doc/maven-properties.tmpl.adoc
rename to src/changelog/.index.adoc.ftl
index 907c36c..0d60c17 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/changelog/.index.adoc.ftl
@@ -22,18 +22,20 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE IS CALLED `index.adoc`, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ Release notes `index.adoc` is generated from `src/changelog/.index.adoc.ftl`.
+ Auto-generation happens during `generate-sources` phase of Maven.
Hence, you must always
- 1. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 1. Edit `.index.adoc.ftl`
+ 2. Run `./mvnw generate-sources`
+ 3. Commit both `.index.adoc.ftl` and the generated `.index.adoc`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes]
+== Release Notes
+
+<#list releases as release>
+include::release-notes/_${release.version}.adoc[]
+</#list>
diff --git a/src/changelog/.index.md.ftl b/src/changelog/.index.md.ftl
deleted file mode 100644
index 693f1f8..0000000
--- a/src/changelog/.index.md.ftl
+++ /dev/null
@@ -1,22 +0,0 @@
-<#--
- ~ 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 Notes
-
-<#list releases as release>
-* [${release.version}](${release.version}.md)<#if release.date?has_content> (${release.date})</#if>
-</#list>
diff --git a/doc/maven-properties.tmpl.adoc b/src/changelog/1.0.0/.release-notes.adoc.ftl
similarity index 65%
copy from doc/maven-properties.tmpl.adoc
copy to src/changelog/1.0.0/.release-notes.adoc.ftl
index 907c36c..35663d1 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/changelog/1.0.0/.release-notes.adoc.ftl
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,22 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+=== ${release.version}
+
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+
+This is the first major release of the project.
+
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/1.0.0/.release-notes.md.ftl b/src/changelog/1.0.0/.release-notes.md.ftl
deleted file mode 100644
index 4b44a83..0000000
--- a/src/changelog/1.0.0/.release-notes.md.ftl
+++ /dev/null
@@ -1,22 +0,0 @@
-<#--
- ~ 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.version}<#if release.date?has_content> (${release.date})</#if>
-
-This is the first major release of the project.
-
-<#include "../.changelog.md.ftl">
diff --git a/src/changelog/1.0.0/LOG4J2-1705_Create_Kotlin_API.xml b/src/changelog/1.0.0/LOG4J2-1705_Create_Kotlin_API.xml
index 2c3a257..cbbfb4d 100644
--- a/src/changelog/1.0.0/LOG4J2-1705_Create_Kotlin_API.xml
+++ b/src/changelog/1.0.0/LOG4J2-1705_Create_Kotlin_API.xml
@@ -5,5 +5,5 @@
<issue id="LOG4J2-3556" link="https://issues.apache.org/jira/browse/LOG4J2-1705"/>
<author id="github:jvz"/>
<author id="github:rocketraman"/>
- <description format="markdown">Create Kotlin wrapper API for Log4j</description>
+ <description format="asciidoc">Create Kotlin wrapper API for Log4j</description>
</entry>
diff --git a/src/changelog/1.0.0/LOG4J2-2432_Make_namedLogger_more_discoverable.xml b/src/changelog/1.0.0/LOG4J2-2432_Make_namedLogger_more_discoverable.xml
index 06b4b2b..8d3743c 100644
--- a/src/changelog/1.0.0/LOG4J2-2432_Make_namedLogger_more_discoverable.xml
+++ b/src/changelog/1.0.0/LOG4J2-2432_Make_namedLogger_more_discoverable.xml
@@ -5,5 +5,5 @@
<issue id="LOG4J2-2432" link="https://issues.apache.org/jira/browse/LOG4J2-2432"/>
<author id="github:jvz"/>
<author id="github:rocketraman"/>
- <description format="markdown">Make `namedLogger` more discoverable</description>
+ <description format="asciidoc">Make `namedLogger` more discoverable</description>
</entry>
diff --git a/doc/maven-properties.tmpl.adoc b/src/changelog/1.1.0/.release-notes.adoc.ftl
similarity index 65%
copy from doc/maven-properties.tmpl.adoc
copy to src/changelog/1.1.0/.release-notes.adoc.ftl
index 907c36c..9351c3d 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/changelog/1.1.0/.release-notes.adoc.ftl
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,22 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+=== ${release.version}
+
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+
+This is the 2nd minor release of the project.
+
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/1.1.0/.release-notes.md.ftl b/src/changelog/1.1.0/.release-notes.md.ftl
deleted file mode 100644
index 6af659d..0000000
--- a/src/changelog/1.1.0/.release-notes.md.ftl
+++ /dev/null
@@ -1,22 +0,0 @@
-<#--
- ~ 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.version}<#if release.date?has_content> (${release.date})</#if>
-
-This is the 2nd minor release of the project.
-
-<#include "../.changelog.md.ftl">
diff --git a/src/changelog/1.1.0/LOG4J2-2433_Support_MDCs_with_coroutines.xml b/src/changelog/1.1.0/LOG4J2-2433_Support_MDCs_with_coroutines.xml
index 6cb21ef..ee10c1a 100644
--- a/src/changelog/1.1.0/LOG4J2-2433_Support_MDCs_with_coroutines.xml
+++ b/src/changelog/1.1.0/LOG4J2-2433_Support_MDCs_with_coroutines.xml
@@ -4,5 +4,5 @@
type="added">
<issue id="LOG4J2-2433" link="https://issues.apache.org/jira/browse/LOG4J2-2433"/>
<author id="github:rocketraman"/>
- <description format="markdown">Support MDCs with Kotlin coroutines</description>
+ <description format="asciidoc">Support MDCs with Kotlin coroutines</description>
</entry>
diff --git a/src/changelog/1.1.0/LOG4J2-2518_Support_suspend_functions.xml b/src/changelog/1.1.0/LOG4J2-2518_Support_suspend_functions.xml
index 08e38e1..d565154 100644
--- a/src/changelog/1.1.0/LOG4J2-2518_Support_suspend_functions.xml
+++ b/src/changelog/1.1.0/LOG4J2-2518_Support_suspend_functions.xml
@@ -4,5 +4,5 @@
type="added">
<issue id="LOG4J2-2518" link="https://issues.apache.org/jira/browse/LOG4J2-2518"/>
<author id="github:rocketraman"/>
- <description format="markdown">Support suspend functions in supplier lambdas</description>
+ <description format="asciidoc">Support suspend functions in supplier lambdas</description>
</entry>
diff --git a/src/changelog/1.1.0/LOG4J2-2843_Update_Kotlin_baseline_to_1.3.72.xml b/src/changelog/1.1.0/LOG4J2-2843_Update_Kotlin_baseline_to_1.3.72.xml
index 021fcb3..4926b15 100644
--- a/src/changelog/1.1.0/LOG4J2-2843_Update_Kotlin_baseline_to_1.3.72.xml
+++ b/src/changelog/1.1.0/LOG4J2-2843_Update_Kotlin_baseline_to_1.3.72.xml
@@ -4,5 +4,5 @@
type="changed">
<issue id="LOG4J2-2843" link="https://issues.apache.org/jira/browse/LOG4J2-2843"/>
<author id="github:rocketraman"/>
- <description format="markdown">Update Kotlin baseline version to 1.3.72</description>
+ <description format="asciidoc">Update Kotlin baseline version to 1.3.72</description>
</entry>
diff --git a/doc/maven-properties.tmpl.adoc b/src/changelog/1.2.0/.release-notes.adoc.ftl
similarity index 65%
copy from doc/maven-properties.tmpl.adoc
copy to src/changelog/1.2.0/.release-notes.adoc.ftl
index 907c36c..d44d45d 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/changelog/1.2.0/.release-notes.adoc.ftl
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,22 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+=== ${release.version}
+
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+
+This is the 3rd minor release of the project.
+
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/1.2.0/.release-notes.md.ftl b/src/changelog/1.2.0/.release-notes.md.ftl
deleted file mode 100644
index 95fcc8c..0000000
--- a/src/changelog/1.2.0/.release-notes.md.ftl
+++ /dev/null
@@ -1,22 +0,0 @@
-<#--
- ~ 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.version}<#if release.date?has_content> (${release.date})</#if>
-
-Changes staged for the next 1.x.x version that is yet to be released.
-
-<#include "../.changelog.md.ftl">
diff --git a/src/changelog/1.2.0/LOG4J2-3218_Update_Log4j_baseline.xml b/src/changelog/1.2.0/LOG4J2-3218_Update_Log4j_baseline.xml
index 5027bd7..60b1954 100644
--- a/src/changelog/1.2.0/LOG4J2-3218_Update_Log4j_baseline.xml
+++ b/src/changelog/1.2.0/LOG4J2-3218_Update_Log4j_baseline.xml
@@ -4,5 +4,5 @@
type="changed">
<issue id="LOG4J2-3218" link="https://issues.apache.org/jira/browse/LOG4J2-3218"/>
<author id="github:rocketraman"/>
- <description format="markdown">Update Kotlin baseline version to 1.3.72</description>
+ <description format="asciidoc">Update Kotlin baseline version to `1.3.72`</description>
</entry>
diff --git a/doc/maven-properties.adoc b/src/site/_constants.adoc
similarity index 70%
rename from doc/maven-properties.adoc
rename to src/site/_constants.adoc
index de046bc..9ac7445 100644
--- a/doc/maven-properties.adoc
+++ b/src/site/_constants.adoc
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,21 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.tmpl.adoc` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ `_constants.adoc` is auto-generated from `_constants.tmpl.adoc`.
+ Auto-generation happens during `process-sources` phase of Maven.
Hence, you must always
- 1. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 1. Edit `_constants.tmpl.adoc`
+ 2. Run `./mvnw process-sources`
+ 3. Commit both `_constants.tmpl.adoc` and the generated `_constants.adoc`
////
+:project-github-url: https://github.com/apache/logging-log4j-kotlin
:project-version: 1.3.0-SNAPSHOT
-:java-version: 17.0.8
+:project-name: Log4j Kotlin API
+:project-id: log4j-kotlin
+:java-target-version: 17.0.8
+:java-compiler-version: [17,18)
:kotlin-version: 1.6.21
diff --git a/doc/maven-properties.tmpl.adoc b/src/site/_constants.tmpl.adoc
similarity index 71%
copy from doc/maven-properties.tmpl.adoc
copy to src/site/_constants.tmpl.adoc
index 907c36c..ce4b5c5 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/site/_constants.tmpl.adoc
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,21 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.tmpl.adoc` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ `_constants.adoc` is auto-generated from `_constants.tmpl.adoc`.
+ Auto-generation happens during `process-sources` phase of Maven.
Hence, you must always
- 1. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 1. Edit `_constants.tmpl.adoc`
+ 2. Run `./mvnw process-sources`
+ 3. Commit both `_constants.tmpl.adoc` and the generated `_constants.adoc`
////
+:project-github-url: ${scm.url}
:project-version: ${project.version}
-:java-version: ${java.version}
+:project-name: Log4j Kotlin API
+:project-id: log4j-kotlin
+:java-target-version: ${java.version}
+:java-compiler-version: ${minimalJavaBuildVersion}
:kotlin-version: ${kotlin.version}
diff --git a/doc/manual.adoc b/src/site/index.adoc
similarity index 62%
rename from doc/manual.adoc
rename to src/site/index.adoc
index 4959d4a..2e83ecd 100644
--- a/doc/manual.adoc
+++ b/src/site/index.adoc
@@ -15,12 +15,14 @@
limitations under the License.
////
-include::maven-properties.adoc[]
+include::_constants.adoc[]
:log4j-url: https://logging.apache.org/log4j/2.x
:log4j-api-url: {log4j-url}/manual/api-separation.html
-Log4j Kotlin API provides a Kotlin-friendly interface to log against {log4j-api-url}[the Log4j API].
-The minimum requirements are Java {java-version} and Kotlin {kotlin-version}.
+= Log4j Kotlin API
+
+{project-name} provides a Kotlin-friendly interface to log against {log4j-api-url}[the Log4j API].
+The minimum requirements are Java `{java-target-version}` and Kotlin `{kotlin-version}`.
[IMPORTANT]
====
@@ -190,3 +192,69 @@
----
This is also needed in scopes that do not have a `this` object, such as top-level functions.
+
+
+
+[#development]
+== Development
+
+{project-name} uses {project-github-url}[GitHub] for source code management.
+
+The project requires a Java compiler matching the `{java-compiler-version}` range and targets Java `{java-target-version}` and Kotlin `{kotlin-version}`.
+
+You can build and verify sources using:
+
+[source,bash]
+----
+./mvnw verify
+----
+
+You can build and view the website as follows:
+
+[source,bash]
+----
+./mvnw -N site
+python -m http.server -d target/site
+----
+
+[#distribution]
+== Distribution
+
+In accordance with the Apache Software Foundation's release https://infra.apache.org/release-distribution.html[distribution policy] and https://infra.apache.org/release-publishing.html[creation process], project artifacts are _officially_ accessible from the following locations:
+
+* ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository])
+* ASF https://downloads.apache.org/logging/{project-id}[Distribution directory]
+
+See xref:#release-instructions[the release instructions] for details.
+
+[#support]
+== Support
+
+Please keep in mind that this project is intended for internal usage only.
+You can use GitHub Issues for feature requests and bug reports – not questions!
+See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details.
+
+[#security]
+== Security
+
+If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:security@logging.apache.org[the Log4j security mailing list].
+See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details.
+
+include::release-notes.adoc[]
+
+[#release-instructions]
+== Release instructions
+
+{project-name} employs the CI/CD foundation provided by the https://logging.apache.org/logging-parent[`logging-parent`].
+You can simply use https://logging.apache.org/logging-parent/release-instructions.html[its release instructions].
+
+[#license]
+== License
+
+Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
+See `NOTICE.txt` 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 https://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.
diff --git a/doc/maven-properties.tmpl.adoc b/src/site/release-notes.adoc
similarity index 72%
copy from doc/maven-properties.tmpl.adoc
copy to src/site/release-notes.adoc
index 907c36c..41f4452 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/site/release-notes.adoc
@@ -22,18 +22,21 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE IS CALLED `index.adoc`, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ Release notes `index.adoc` is generated from `src/changelog/.index.adoc.ftl`.
+ Auto-generation happens during `generate-sources` phase of Maven.
Hence, you must always
- 1. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 1. Edit `.index.adoc.ftl`
+ 2. Run `./mvnw generate-sources`
+ 3. Commit both `.index.adoc.ftl` and the generated `.index.adoc`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes]
+== Release Notes
+
+include::release-notes/_1.x.x.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/doc/maven-properties.tmpl.adoc b/src/site/release-notes/_1.0.0.adoc
similarity index 63%
copy from doc/maven-properties.tmpl.adoc
copy to src/site/release-notes/_1.0.0.adoc
index 907c36c..952dfff 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/site/release-notes/_1.0.0.adoc
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,29 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes-1-0-0]
+=== 1.0.0
+
+Release date:: 2018-11-03
+
+This is the first major release of the project.
+
+
+==== Added
+
+* Create Kotlin wrapper API for Log4j (https://issues.apache.org/jira/browse/LOG4J2-1705[LOG4J2-3556])
+
+==== Changed
+
+* Make `namedLogger` more discoverable (https://issues.apache.org/jira/browse/LOG4J2-2432[LOG4J2-2432])
diff --git a/doc/maven-properties.tmpl.adoc b/src/site/release-notes/_1.1.0.adoc
similarity index 60%
copy from doc/maven-properties.tmpl.adoc
copy to src/site/release-notes/_1.1.0.adoc
index 907c36c..6df748c 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/site/release-notes/_1.1.0.adoc
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,30 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes-1-1-0]
+=== 1.1.0
+
+Release date:: 2021-08-28
+
+This is the 2nd minor release of the project.
+
+
+==== Added
+
+* Support MDCs with Kotlin coroutines (https://issues.apache.org/jira/browse/LOG4J2-2433[LOG4J2-2433])
+* Support suspend functions in supplier lambdas (https://issues.apache.org/jira/browse/LOG4J2-2518[LOG4J2-2518])
+
+==== Changed
+
+* Update Kotlin baseline version to 1.3.72 (https://issues.apache.org/jira/browse/LOG4J2-2843[LOG4J2-2843])
diff --git a/doc/maven-properties.tmpl.adoc b/src/site/release-notes/_1.2.0.adoc
similarity index 66%
copy from doc/maven-properties.tmpl.adoc
copy to src/site/release-notes/_1.2.0.adoc
index 907c36c..c44d13b 100644
--- a/doc/maven-properties.tmpl.adoc
+++ b/src/site/release-notes/_1.2.0.adoc
@@ -6,7 +6,7 @@
(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
+ 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,
@@ -22,18 +22,25 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `maven-properties.adoc`, DO NOT EDIT IT!
- ALWAYS EDIT `maven-properties.tmpl.adoc`!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- `maven-properties.adoc` is generated from `maven-properties.tmpl.adoc` by Maven.
+ 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. Edit `maven-properties.tmpl.adoc`
- 2. Run `./mvnw generate-resources`
- 3. Commit both `maven-properties.tmpl.adoc` and `maven-properties.adoc`
-
+ 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`
////
-:project-version: ${project.version}
-:java-version: ${java.version}
-:kotlin-version: ${kotlin.version}
+[#release-notes-1-2-0]
+=== 1.2.0
+
+Release date:: 2021-12-20
+
+This is the 3rd minor release of the project.
+
+
+==== Changed
+
+* Update Kotlin baseline version to `1.3.72` (https://issues.apache.org/jira/browse/LOG4J2-3218[LOG4J2-3218])
diff --git a/src/site/release-notes/_1.x.x.adoc b/src/site/release-notes/_1.x.x.adoc
new file mode 100644
index 0000000..23d5c37
--- /dev/null
+++ b/src/site/release-notes/_1.x.x.adoc
@@ -0,0 +1,55 @@
+////
+ 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-x-x]
+=== 1.x.x
+
+
+
+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])
+
+==== Changed
+
+* Updated Log4j dependency to `2.20.0`
+* Bumped `logging-parent` version to `10.0.0` and overhauled the entire project infrastructure to take advantage of its goodies (https://github.com/apache/logging-log4j-kotlin/pull/37[37])
+* Migrated tests to JUnit 5
+* Bumped Kotlin and Kotlin Extensions baseline to `1.6.21` and `1.6.4` respectively
