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/27 08:12:51 UTC

[logging-parent] branch release/10.1.0 updated: Fix release notes directory structure

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

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


The following commit(s) were added to refs/heads/release/10.1.0 by this push:
     new 40fa549  Fix release notes directory structure
40fa549 is described below

commit 40fa5490ea0cc1478770001ea8e6504b76a0d3fc
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Wed Sep 27 10:13:04 2023 +0200

    Fix release notes directory structure
---
 pom.xml                                            |  6 ++--
 src/changelog/.index.adoc.ftl                      |  2 +-
 src/site/_release-notes.adoc                       |  5 ++-
 .../{release-notes => _release-notes}/_10.0.0.adoc |  0
 .../{release-notes => _release-notes}/_10.1.0.adoc |  0
 .../{release-notes => _release-notes}/_10.x.x.adoc |  0
 src/site/release-notes.adoc                        | 41 ----------------------
 7 files changed, 6 insertions(+), 48 deletions(-)

diff --git a/pom.xml b/pom.xml
index b0628fb..9ddc932 100644
--- a/pom.xml
+++ b/pom.xml
@@ -678,13 +678,13 @@
                   <indexTemplates>
                     <template>
                       <source>.index.adoc.ftl</source>
-                      <target>release-notes.adoc</target>
+                      <target>_release-notes.adoc</target>
                     </template>
                   </indexTemplates>
                   <changelogTemplates>
                     <template>
                       <source>.release-notes.adoc.ftl</source>
-                      <target>release-notes/_%v.adoc</target>
+                      <target>_release-notes/_%v.adoc</target>
                     </template>
                   </changelogTemplates>
                 </configuration>
@@ -813,7 +813,7 @@
 
                 // Find auxiliary files that will go into the binary distribution
                 SortedMap pathByFile = new TreeMap();
-                pathByFile.put("RELEASE-NOTES.adoc", new File("src/site/release-notes/${project.version}.adoc").toPath());
+                pathByFile.put("RELEASE-NOTES.adoc", new File("src/site/_release-notes/_${project.version}.adoc").toPath());
                 pathByFile.put("README.adoc", new File("README.adoc").toPath());
                 pathByFile.put("NOTICE.txt", new File("NOTICE.txt").toPath());
                 pathByFile.put("LICENSE.txt", new File("LICENSE.txt").toPath());
diff --git a/src/changelog/.index.adoc.ftl b/src/changelog/.index.adoc.ftl
index 7e7b95c..8c4ff21 100644
--- a/src/changelog/.index.adoc.ftl
+++ b/src/changelog/.index.adoc.ftl
@@ -37,5 +37,5 @@
 == Release Notes
 
 <#list releases as release><#if release.changelogEntryCount gt 0>
-include::release-notes/_${release.version}.adoc[]
+include::_release-notes/_${release.version}.adoc[]
 </#if></#list>
diff --git a/src/site/_release-notes.adoc b/src/site/_release-notes.adoc
index da4d283..b747193 100644
--- a/src/site/_release-notes.adoc
+++ b/src/site/_release-notes.adoc
@@ -36,6 +36,5 @@
 [#release-notes]
 == Release Notes
 
-include::release-notes/_10.x.x.adoc[]
-include::release-notes/_10.1.0.adoc[]
-include::release-notes/_10.0.0.adoc[]
+include::_release-notes/_10.1.0.adoc[]
+include::_release-notes/_10.0.0.adoc[]
diff --git a/src/site/release-notes/_10.0.0.adoc b/src/site/_release-notes/_10.0.0.adoc
similarity index 100%
rename from src/site/release-notes/_10.0.0.adoc
rename to src/site/_release-notes/_10.0.0.adoc
diff --git a/src/site/release-notes/_10.1.0.adoc b/src/site/_release-notes/_10.1.0.adoc
similarity index 100%
rename from src/site/release-notes/_10.1.0.adoc
rename to src/site/_release-notes/_10.1.0.adoc
diff --git a/src/site/release-notes/_10.x.x.adoc b/src/site/_release-notes/_10.x.x.adoc
similarity index 100%
rename from src/site/release-notes/_10.x.x.adoc
rename to src/site/_release-notes/_10.x.x.adoc
diff --git a/src/site/release-notes.adoc b/src/site/release-notes.adoc
deleted file mode 100644
index da4d283..0000000
--- a/src/site/release-notes.adoc
+++ /dev/null
@@ -1,41 +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.
-////
-
-////
-    ██     ██  █████  ██████  ███    ██ ██ ███    ██  ██████  ██
-    ██     ██ ██   ██ ██   ██ ████   ██ ██ ████   ██ ██       ██
-    ██  █  ██ ███████ ██████  ██ ██  ██ ██ ██ ██  ██ ██   ███ ██
-    ██ ███ ██ ██   ██ ██   ██ ██  ██ ██ ██ ██  ██ ██ ██    ██
-     ███ ███  ██   ██ ██   ██ ██   ████ ██ ██   ████  ██████  ██
-
-    IF THIS FILE IS CALLED `index.adoc`, IT IS AUTO-GENERATED, DO NOT EDIT IT!
-
-    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 `.index.adoc.ftl`
-    2. Run `./mvnw generate-sources`
-    3. Commit both `.index.adoc.ftl` and the generated `.index.adoc`
-////
-
-[#release-notes]
-== Release Notes
-
-include::release-notes/_10.x.x.adoc[]
-include::release-notes/_10.1.0.adoc[]
-include::release-notes/_10.0.0.adoc[]