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 2024/03/18 20:02:11 UTC
(logging-log4j-tools) 02/03: Release the changelog
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch release/0.8.0
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit 9b41029267e670f6fb05e758cf647a4bf12188e8
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Mon Mar 18 20:56:36 2024 +0100
Release the changelog
---
.../0.8.0/.release-notes.adoc.ftl} | 31 +++++++++++-----------
src/changelog/0.8.0/.release.xml | 21 +++++++++++++++
.../{.0.x.x => 0.8.0}/add_log4j_docgen.xml | 0
.../{.0.x.x => 0.8.0}/move_changelog_xml_ns.xml | 0
.../{.0.x.x => 0.8.0}/remove_changelog_author.xml | 0
.../update_apache_logging_parent.xml | 0
.../update_jakarta_inject_jakarta_inject_api.xml | 0
.../update_org_apache_logging_log4j_log4j_core.xml | 0
...date_org_apache_logging_log4j_log4j_plugins.xml | 0
...maven_plugin_tools_maven_plugin_annotations.xml | 0
.../update_org_assertj_assertj_core.xml | 0
...e_org_codehaus_modello_modello_maven_plugin.xml | 0
.../update_org_junit_junit_bom.xml | 0
src/site/_constants.adoc | 2 +-
src/site/_release-notes.adoc | 2 +-
.../_release-notes/{_0.x.x.adoc => _0.8.0.adoc} | 18 +++++++------
src/site/_release-notes/_0.x.x.adoc | 30 ---------------------
17 files changed, 48 insertions(+), 56 deletions(-)
diff --git a/src/site/_release-notes.adoc b/src/changelog/0.8.0/.release-notes.adoc.ftl
similarity index 62%
copy from src/site/_release-notes.adoc
copy to src/changelog/0.8.0/.release-notes.adoc.ftl
index 240afd2..2336926 100644
--- a/src/site/_release-notes.adoc
+++ b/src/changelog/0.8.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,25 +22,24 @@
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██
- IF THIS FILE IS CALLED `index.adoc`, IT IS AUTO-GENERATED, DO NOT EDIT IT!
+ IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!
- Release notes `index.adoc` is generated from `src/changelog/.index.adoc.ftl`.
+ 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 `.index.adoc.ftl`
+ 1. Find and edit the associated `.release-notes.adoc.ftl`
2. Run `./mvnw generate-sources`
- 3. Commit both `.index.adoc.ftl` and the generated `.index.adoc`
+ 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
////
-[#release-notes]
-== Release Notes
-
-include::_release-notes/_0.x.x.adoc[]
-include::_release-notes/_0.7.0.adoc[]
-include::_release-notes/_0.6.0.adoc[]
-include::_release-notes/_0.5.0.adoc[]
-include::_release-notes/_0.4.0.adoc[]
-include::_release-notes/_0.3.0.adoc[]
-include::_release-notes/_0.2.0.adoc[]
-include::_release-notes/_0.1.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 delivers the first version of Log4j Docgen (Documentation Generator).
+It is a set of tools to auto-generate the Log4j plugin documentation (to be integrated into the website) and the Log4j configuration XSD file (for assisting the configuration of the Log4j runtime, i.e., `log4j2.xml`) from the Log4j source code.
+See the project website for details.
+
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/0.8.0/.release.xml b/src/changelog/0.8.0/.release.xml
new file mode 100644
index 0000000..2ef3b0e
--- /dev/null
+++ b/src/changelog/0.8.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.3.xsd"
+ date="2024-03-18" version="0.8.0"/>
diff --git a/src/changelog/.0.x.x/add_log4j_docgen.xml b/src/changelog/0.8.0/add_log4j_docgen.xml
similarity index 100%
rename from src/changelog/.0.x.x/add_log4j_docgen.xml
rename to src/changelog/0.8.0/add_log4j_docgen.xml
diff --git a/src/changelog/.0.x.x/move_changelog_xml_ns.xml b/src/changelog/0.8.0/move_changelog_xml_ns.xml
similarity index 100%
rename from src/changelog/.0.x.x/move_changelog_xml_ns.xml
rename to src/changelog/0.8.0/move_changelog_xml_ns.xml
diff --git a/src/changelog/.0.x.x/remove_changelog_author.xml b/src/changelog/0.8.0/remove_changelog_author.xml
similarity index 100%
rename from src/changelog/.0.x.x/remove_changelog_author.xml
rename to src/changelog/0.8.0/remove_changelog_author.xml
diff --git a/src/changelog/.0.x.x/update_apache_logging_parent.xml b/src/changelog/0.8.0/update_apache_logging_parent.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_apache_logging_parent.xml
rename to src/changelog/0.8.0/update_apache_logging_parent.xml
diff --git a/src/changelog/.0.x.x/update_jakarta_inject_jakarta_inject_api.xml b/src/changelog/0.8.0/update_jakarta_inject_jakarta_inject_api.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_jakarta_inject_jakarta_inject_api.xml
rename to src/changelog/0.8.0/update_jakarta_inject_jakarta_inject_api.xml
diff --git a/src/changelog/.0.x.x/update_org_apache_logging_log4j_log4j_core.xml b/src/changelog/0.8.0/update_org_apache_logging_log4j_log4j_core.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_org_apache_logging_log4j_log4j_core.xml
rename to src/changelog/0.8.0/update_org_apache_logging_log4j_log4j_core.xml
diff --git a/src/changelog/.0.x.x/update_org_apache_logging_log4j_log4j_plugins.xml b/src/changelog/0.8.0/update_org_apache_logging_log4j_log4j_plugins.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_org_apache_logging_log4j_log4j_plugins.xml
rename to src/changelog/0.8.0/update_org_apache_logging_log4j_log4j_plugins.xml
diff --git a/src/changelog/.0.x.x/update_org_apache_maven_plugin_tools_maven_plugin_annotations.xml b/src/changelog/0.8.0/update_org_apache_maven_plugin_tools_maven_plugin_annotations.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_org_apache_maven_plugin_tools_maven_plugin_annotations.xml
rename to src/changelog/0.8.0/update_org_apache_maven_plugin_tools_maven_plugin_annotations.xml
diff --git a/src/changelog/.0.x.x/update_org_assertj_assertj_core.xml b/src/changelog/0.8.0/update_org_assertj_assertj_core.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_org_assertj_assertj_core.xml
rename to src/changelog/0.8.0/update_org_assertj_assertj_core.xml
diff --git a/src/changelog/.0.x.x/update_org_codehaus_modello_modello_maven_plugin.xml b/src/changelog/0.8.0/update_org_codehaus_modello_modello_maven_plugin.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_org_codehaus_modello_modello_maven_plugin.xml
rename to src/changelog/0.8.0/update_org_codehaus_modello_modello_maven_plugin.xml
diff --git a/src/changelog/.0.x.x/update_org_junit_junit_bom.xml b/src/changelog/0.8.0/update_org_junit_junit_bom.xml
similarity index 100%
rename from src/changelog/.0.x.x/update_org_junit_junit_bom.xml
rename to src/changelog/0.8.0/update_org_junit_junit_bom.xml
diff --git a/src/site/_constants.adoc b/src/site/_constants.adoc
index 8be53de..f51ea66 100644
--- a/src/site/_constants.adoc
+++ b/src/site/_constants.adoc
@@ -34,7 +34,7 @@
////
:project-github-url: https://github.com/apache/logging-log4j-tools
-:project-version: 0.8.0-SNAPSHOT
+:project-version: 0.8.0
:project-name: Log4j Tools
:project-id: log4j-tools
:java-target-version: 8
diff --git a/src/site/_release-notes.adoc b/src/site/_release-notes.adoc
index 240afd2..9d4623f 100644
--- a/src/site/_release-notes.adoc
+++ b/src/site/_release-notes.adoc
@@ -36,7 +36,7 @@
[#release-notes]
== Release Notes
-include::_release-notes/_0.x.x.adoc[]
+include::_release-notes/_0.8.0.adoc[]
include::_release-notes/_0.7.0.adoc[]
include::_release-notes/_0.6.0.adoc[]
include::_release-notes/_0.5.0.adoc[]
diff --git a/src/site/_release-notes/_0.x.x.adoc b/src/site/_release-notes/_0.8.0.adoc
similarity index 86%
copy from src/site/_release-notes/_0.x.x.adoc
copy to src/site/_release-notes/_0.8.0.adoc
index c41c31e..ef76229 100644
--- a/src/site/_release-notes/_0.x.x.adoc
+++ b/src/site/_release-notes/_0.8.0.adoc
@@ -33,25 +33,27 @@
3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
////
-[#release-notes-0-x-x]
-=== 0.x.x
+[#release-notes-0-8-0]
+=== 0.8.0
+Release date:: 2024-03-18
+This release delivers the first version of Log4j Docgen (Documentation Generator).
+It is a set of tools to auto-generate the Log4j plugin documentation (to be integrated into the website) and the Log4j configuration XSD file (for assisting the configuration of the Log4j runtime, i.e., `log4j2.xml`) from the Log4j source code.
+See the project website for details.
-This minor release contains various bug fixes and improvements.
-
-[#release-notes-0-x-x-added]
+[#release-notes-0-8-0-added]
==== Added
* Add the `log4j-docgen` et al. containing a universal XML model to document Log4j plugins
-[#release-notes-0-x-x-changed]
+[#release-notes-0-8-0-changed]
==== Changed
* Move `log4j-changelog` XML namespace and schema location to `https://logging.apache.org/xml/ns` and `https://logging.apache.org/xml/ns/log4j-changelog-0.xsd`, respectively
-[#release-notes-0-x-x-removed]
+[#release-notes-0-8-0-removed]
==== Removed
* Remove `author` from `log4j-changelog`.
@@ -59,7 +61,7 @@ This minor release contains various bug fixes and improvements.
It was yet another bit to maintain and created role-related (who did what) problems.
Many modern software projects use a VCS (e.g., Git) and support services (e.g., GitHub) which make it trivial to trace back the origin of a change using commit and issue IDs.
-[#release-notes-0-x-x-updated]
+[#release-notes-0-8-0-updated]
==== Updated
* Update `org.apache.logging:logging-parent` to version `10.6.0`
diff --git a/src/site/_release-notes/_0.x.x.adoc b/src/site/_release-notes/_0.x.x.adoc
index c41c31e..5e8caa4 100644
--- a/src/site/_release-notes/_0.x.x.adoc
+++ b/src/site/_release-notes/_0.x.x.adoc
@@ -40,33 +40,3 @@
This minor release contains various bug fixes and improvements.
-
-[#release-notes-0-x-x-added]
-==== Added
-
-* Add the `log4j-docgen` et al. containing a universal XML model to document Log4j plugins
-
-[#release-notes-0-x-x-changed]
-==== Changed
-
-* Move `log4j-changelog` XML namespace and schema location to `https://logging.apache.org/xml/ns` and `https://logging.apache.org/xml/ns/log4j-changelog-0.xsd`, respectively
-
-[#release-notes-0-x-x-removed]
-==== Removed
-
-* Remove `author` from `log4j-changelog`.
-+
-It was yet another bit to maintain and created role-related (who did what) problems.
-Many modern software projects use a VCS (e.g., Git) and support services (e.g., GitHub) which make it trivial to trace back the origin of a change using commit and issue IDs.
-
-[#release-notes-0-x-x-updated]
-==== Updated
-
-* Update `org.apache.logging:logging-parent` to version `10.6.0`
-* Update `jakarta.inject:jakarta.inject-api` to version `2.0.1` (https://github.com/apache/logging-log4j-tools/pull/94[94])
-* Update `org.apache.logging.log4j:log4j-core` to version `2.23.1` (https://github.com/apache/logging-log4j-tools/pull/108[108])
-* Update `org.apache.logging.log4j:log4j-plugins` to version `3.0.0-beta2` (https://github.com/apache/logging-log4j-tools/pull/107[107])
-* Update `org.apache.maven.plugin-tools:maven-plugin-annotations` to version `3.11.0` (https://github.com/apache/logging-log4j-tools/pull/98[98])
-* Update `org.assertj:assertj-core` to version `3.25.3` (https://github.com/apache/logging-log4j-tools/pull/104[104])
-* Update `org.codehaus.modello:modello-maven-plugin` to version `2.3.0` (https://github.com/apache/logging-log4j-tools/pull/105[105])
-* Update `org.junit:junit-bom` to version `5.10.2` (https://github.com/apache/logging-log4j-tools/pull/103[103])