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/09/19 09:27:47 UTC

[logging-parent] 05/07: Migrate more stuff to AsciiDoc

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-parent.git

commit 79c45553c2f1bcbee4529f1f700c1d2588a1c929
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Sep 19 09:42:37 2023 +0200

    Migrate more stuff to AsciiDoc
---
 README.adoc        |  8 ++++----
 RELEASE-NOTES.adoc | 21 +++++++++++++++++++++
 RELEASE-NOTES.md   | 21 ---------------------
 3 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/README.adoc b/README.adoc
index 2feae07..c40821a 100644
--- a/README.adoc
+++ b/README.adoc
@@ -33,15 +33,15 @@ You can use this project as follows:
 . Add `org.apache.logging:logging-parent` as a `parent` to your `pom.xml`
 .. Check if `./mvnw verify` succeeds, otherwise make necessary changes
 . Copy and adapt following files:
-.. xref:src/changelog/.10.x.x/.release-notes.md.ftl[] (adapt the folder name to match your project; `.2.x.x`, `.3.x.x`, etc.)
-.. xref:src/changelog/.changelog.md.ftl[]
-.. xref:src/changelog/.index.md.ftl[]
+.. xref:src/changelog/.10.x.x/.release-notes.adoc.ftl[] (adapt the folder name to match your project; `.2.x.x`, `.3.x.x`, etc.)
+.. xref:src/changelog/.changelog.adoc.ftl[]
+.. xref:src/changelog/.index.adoc.ftl[]
 .. xref:.github/workflows/build.yaml[]
 .. xref:.github/generate-email.sh[]
 .. xref:LICENSE.txt[]
 .. xref:NOTICE.txt[]
 .. xref:README.adoc[] (you can reuse _Distribution_, _Support_, _Security_, and _License_ sections as is)
-.. xref:RELEASE-NOTES.md[]
+.. xref:RELEASE-NOTES.adoc[]
 .. xref:RELEASING.adoc[]
 .. xref:.mvn/jvm.config[] (run `mvn wrapper:wrapper` beforehand)
 
diff --git a/RELEASE-NOTES.adoc b/RELEASE-NOTES.adoc
new file mode 100644
index 0000000..2ab54bb
--- /dev/null
+++ b/RELEASE-NOTES.adoc
@@ -0,0 +1,21 @@
+////
+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.
+////
+
+This project uses https://github.com/apache/logging-log4j-tools/tree/main/log4j-changelog-maven-plugin[`log4j-changelog-maven-plugin`] for keeping a changelog and generating release notes.
+
+Changelog files are located under xref:src/changelog[`src/changelog`].
+Release notes can be generated using `./mvnw -N -P changelog-export` command.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
deleted file mode 100644
index ca933c8..0000000
--- a/RELEASE-NOTES.md
+++ /dev/null
@@ -1,21 +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 `log4j-changelog-maven-plugin` [log4j-changelog-maven-plugin](https://github.com/apache/logging-log4j-tools/tree/main/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.