You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2023/10/10 08:35:18 UTC
[logging-log4j-scala] 02/02: Prepare release notes for version `13.0.0`
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch release/13.0.0
in repository https://gitbox.apache.org/repos/asf/logging-log4j-scala.git
commit cd29469cd22af4db985971372b1c92cabe116fed
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Oct 10 10:33:12 2023 +0200
Prepare release notes for version `13.0.0`
---
src/changelog/.13.x.x/26_fix-scala-3-macros.xml | 10 --------
.../13.0.0/.release-notes.adoc.ftl} | 29 ++++++----------------
.../use-changelog.xml => 13.0.0/.release.xml} | 11 +++-----
.../LOG4J2-3184_add-scala-3.xml | 3 +++
.../{.13.x.x => 13.0.0}/add-module-support.xml | 0
src/changelog/{.13.x.x => 13.0.0}/java-17.xml | 0
.../switch-to-github-actions.xml | 0
.../{.13.x.x => 13.0.0}/switch-to-maven.xml | 0
.../{.13.x.x => 13.0.0}/switch-to-semver.xml | 0
.../update_org_apache_logging_log4j_log4j_api.xml | 0
.../update_org_apache_logging_logging_parent.xml | 0
.../{.13.x.x => 13.0.0}/use-changelog.xml | 0
src/site/_constants.adoc | 2 +-
src/site/_release-notes.adoc | 2 +-
.../_release-notes/{_13.x.x.adoc => _13.0.0.adoc} | 15 ++++++-----
src/site/_release-notes/_13.x.x.adoc | 19 --------------
16 files changed, 23 insertions(+), 68 deletions(-)
diff --git a/src/changelog/.13.x.x/26_fix-scala-3-macros.xml b/src/changelog/.13.x.x/26_fix-scala-3-macros.xml
deleted file mode 100644
index 69c8946..0000000
--- a/src/changelog/.13.x.x/26_fix-scala-3-macros.xml
+++ /dev/null
@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://logging.apache.org/log4j/changelog"
- xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
- type="fixed">
- <issue id="26" link="https://github.com/apache/logging-log4j-scala/pull/26"/>
- <author id="github:Flowdalic" name="Florian Schmaus"/>
- <author id="github:vy"/>
- <description format="asciidoc">Fixed Scala 3 macros</description>
-</entry>
diff --git a/src/site/_release-notes/_13.x.x.adoc b/src/changelog/13.0.0/.release-notes.adoc.ftl
similarity index 71%
copy from src/site/_release-notes/_13.x.x.adoc
copy to src/changelog/13.0.0/.release-notes.adoc.ftl
index 7e9f9c0..93407e7 100644
--- a/src/site/_release-notes/_13.x.x.adoc
+++ b/src/changelog/13.0.0/.release-notes.adoc.ftl
@@ -33,29 +33,14 @@
3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
////
-[#release-notes-13-x-x]
-=== 13.x.x
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+=== ${release.version}
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+The highlights of this major release are Scala 3 support, JPMS descriptors, and the switch to https://semver.org[semantic versioning].
-This minor release contains various bug fixes and improvements.
+Note that this release is still binary backward compatible with the earlier release `12.0`.
+Though we needed to bump the major version number for the semantic versioning switch to avoid the confusion related with version ordering.
-
-==== Added
-
-* Added support for Scala 3 (https://issues.apache.org/jira/browse/LOG4J2-3184[LOG4J2-3184])
-* Added OSGi and JPMS support
-
-==== Changed
-
-* Bumped the Java version to 17 (Scala 2.10 and 2.11 targets still require Java 8 that build switches to using `maven-toolchains-plugin`)
-* Switch the CI to GitHub Actions
-* Switched from `sbt` to Maven to take advantage of `logging-parent` conveniences
-* Switched to semantic versioning
-* Updated `org.apache.logging.log4j:log4j-api` version to `2.20.0`
-* Update `org.apache.logging:logging-parent` to version `10.1.1`
-* Started using `log4j-changelog`
-
-==== Fixed
-
-* Fixed Scala 3 macros (https://github.com/apache/logging-log4j-scala/pull/26[26])
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/.13.x.x/use-changelog.xml b/src/changelog/13.0.0/.release.xml
similarity index 69%
copy from src/changelog/.13.x.x/use-changelog.xml
copy to src/changelog/13.0.0/.release.xml
index 04049f4..20d35f8 100644
--- a/src/changelog/.13.x.x/use-changelog.xml
+++ b/src/changelog/13.0.0/.release.xml
@@ -15,10 +15,7 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://logging.apache.org/log4j/changelog"
- 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">Started using `log4j-changelog`</description>
-</entry>
+<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-10" version="13.0.0"/>
diff --git a/src/changelog/.13.x.x/LOG4J2-3184_add-scala-3.xml b/src/changelog/13.0.0/LOG4J2-3184_add-scala-3.xml
similarity index 76%
rename from src/changelog/.13.x.x/LOG4J2-3184_add-scala-3.xml
rename to src/changelog/13.0.0/LOG4J2-3184_add-scala-3.xml
index 4ba3b8b..ea2d599 100644
--- a/src/changelog/.13.x.x/LOG4J2-3184_add-scala-3.xml
+++ b/src/changelog/13.0.0/LOG4J2-3184_add-scala-3.xml
@@ -4,7 +4,10 @@
xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
type="added">
<issue id="LOG4J2-3184" link="https://issues.apache.org/jira/browse/LOG4J2-3184"/>
+ <issue id="26" link="https://github.com/apache/logging-log4j-scala/pull/26"/>
+ <author id="github:Flowdalic" name="Florian Schmaus"/>
<author id="github:pjfanning"/>
<author id="github:jvz"/>
+ <author id="github:vy"/>
<description format="asciidoc">Added support for Scala 3</description>
</entry>
diff --git a/src/changelog/.13.x.x/add-module-support.xml b/src/changelog/13.0.0/add-module-support.xml
similarity index 100%
rename from src/changelog/.13.x.x/add-module-support.xml
rename to src/changelog/13.0.0/add-module-support.xml
diff --git a/src/changelog/.13.x.x/java-17.xml b/src/changelog/13.0.0/java-17.xml
similarity index 100%
rename from src/changelog/.13.x.x/java-17.xml
rename to src/changelog/13.0.0/java-17.xml
diff --git a/src/changelog/.13.x.x/switch-to-github-actions.xml b/src/changelog/13.0.0/switch-to-github-actions.xml
similarity index 100%
rename from src/changelog/.13.x.x/switch-to-github-actions.xml
rename to src/changelog/13.0.0/switch-to-github-actions.xml
diff --git a/src/changelog/.13.x.x/switch-to-maven.xml b/src/changelog/13.0.0/switch-to-maven.xml
similarity index 100%
rename from src/changelog/.13.x.x/switch-to-maven.xml
rename to src/changelog/13.0.0/switch-to-maven.xml
diff --git a/src/changelog/.13.x.x/switch-to-semver.xml b/src/changelog/13.0.0/switch-to-semver.xml
similarity index 100%
rename from src/changelog/.13.x.x/switch-to-semver.xml
rename to src/changelog/13.0.0/switch-to-semver.xml
diff --git a/src/changelog/.13.x.x/update_org_apache_logging_log4j_log4j_api.xml b/src/changelog/13.0.0/update_org_apache_logging_log4j_log4j_api.xml
similarity index 100%
rename from src/changelog/.13.x.x/update_org_apache_logging_log4j_log4j_api.xml
rename to src/changelog/13.0.0/update_org_apache_logging_log4j_log4j_api.xml
diff --git a/src/changelog/.13.x.x/update_org_apache_logging_logging_parent.xml b/src/changelog/13.0.0/update_org_apache_logging_logging_parent.xml
similarity index 100%
rename from src/changelog/.13.x.x/update_org_apache_logging_logging_parent.xml
rename to src/changelog/13.0.0/update_org_apache_logging_logging_parent.xml
diff --git a/src/changelog/.13.x.x/use-changelog.xml b/src/changelog/13.0.0/use-changelog.xml
similarity index 100%
rename from src/changelog/.13.x.x/use-changelog.xml
rename to src/changelog/13.0.0/use-changelog.xml
diff --git a/src/site/_constants.adoc b/src/site/_constants.adoc
index ab02afe..28b3358 100644
--- a/src/site/_constants.adoc
+++ b/src/site/_constants.adoc
@@ -34,7 +34,7 @@
////
:project-github-url: https://github.com/apache/logging-log4j-scala
-:project-version: 13.0.0-SNAPSHOT
+:project-version: 13.0.0
:project-name: Log4j Scala API
:project-id: log4j-scala
:java-compiler-version: [17,18)
diff --git a/src/site/_release-notes.adoc b/src/site/_release-notes.adoc
index 5cd39bf..f3ac6fc 100644
--- a/src/site/_release-notes.adoc
+++ b/src/site/_release-notes.adoc
@@ -36,5 +36,5 @@
[#release-notes]
== Release Notes
-include::_release-notes/_13.x.x.adoc[]
+include::_release-notes/_13.0.0.adoc[]
include::_release-notes/_12.0.adoc[]
diff --git a/src/site/_release-notes/_13.x.x.adoc b/src/site/_release-notes/_13.0.0.adoc
similarity index 83%
copy from src/site/_release-notes/_13.x.x.adoc
copy to src/site/_release-notes/_13.0.0.adoc
index 7e9f9c0..848a691 100644
--- a/src/site/_release-notes/_13.x.x.adoc
+++ b/src/site/_release-notes/_13.0.0.adoc
@@ -33,17 +33,20 @@
3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
////
-[#release-notes-13-x-x]
-=== 13.x.x
+[#release-notes-13-0-0]
+=== 13.0.0
+Release date:: 2023-10-10
+The highlights of this major release are Scala 3 support, JPMS descriptors, and the switch to https://semver.org[semantic versioning].
-This minor release contains various bug fixes and improvements.
+Note that this release is still binary backward compatible with the earlier release `12.0`.
+Though we needed to bump the major version number for the semantic versioning switch to avoid the confusion related with version ordering.
==== Added
-* Added support for Scala 3 (https://issues.apache.org/jira/browse/LOG4J2-3184[LOG4J2-3184])
+* Added support for Scala 3 (https://issues.apache.org/jira/browse/LOG4J2-3184[LOG4J2-3184], https://github.com/apache/logging-log4j-scala/pull/26[26])
* Added OSGi and JPMS support
==== Changed
@@ -55,7 +58,3 @@ This minor release contains various bug fixes and improvements.
* Updated `org.apache.logging.log4j:log4j-api` version to `2.20.0`
* Update `org.apache.logging:logging-parent` to version `10.1.1`
* Started using `log4j-changelog`
-
-==== Fixed
-
-* Fixed Scala 3 macros (https://github.com/apache/logging-log4j-scala/pull/26[26])
diff --git a/src/site/_release-notes/_13.x.x.adoc b/src/site/_release-notes/_13.x.x.adoc
index 7e9f9c0..a7eada3 100644
--- a/src/site/_release-notes/_13.x.x.adoc
+++ b/src/site/_release-notes/_13.x.x.adoc
@@ -40,22 +40,3 @@
This minor release contains various bug fixes and improvements.
-
-==== Added
-
-* Added support for Scala 3 (https://issues.apache.org/jira/browse/LOG4J2-3184[LOG4J2-3184])
-* Added OSGi and JPMS support
-
-==== Changed
-
-* Bumped the Java version to 17 (Scala 2.10 and 2.11 targets still require Java 8 that build switches to using `maven-toolchains-plugin`)
-* Switch the CI to GitHub Actions
-* Switched from `sbt` to Maven to take advantage of `logging-parent` conveniences
-* Switched to semantic versioning
-* Updated `org.apache.logging.log4j:log4j-api` version to `2.20.0`
-* Update `org.apache.logging:logging-parent` to version `10.1.1`
-* Started using `log4j-changelog`
-
-==== Fixed
-
-* Fixed Scala 3 macros (https://github.com/apache/logging-log4j-scala/pull/26[26])