This is an automated email from the ASF dual-hosted git repository.
pottlinger pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/creadur-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 8d5eae91b RAT-487: Document release notes handling
8d5eae91b is described below
commit 8d5eae91b38ec4def97ac91d035a06c2b1974147
Author: P. Ottlinger <[email protected]>
AuthorDate: Sun Oct 12 16:13:42 2025 +0200
RAT-487: Document release notes handling
---
release-notes/README.md | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/release-notes/README.md b/release-notes/README.md
index 9333a1854..6cd92962c 100644
--- a/release-notes/README.md
+++ b/release-notes/README.md
@@ -1,7 +1,21 @@
# Release Notes Readme
-The webpage links to
+The webpage links to
https://creadur.apache.org/release-notes/rat.txt
in order to show a combined release notes document over *all* available
versions.
Each dedicated version can be found in this subfolder and should be linked
directly (if needed).
+
+## rat.txt
+
+```rat.txt``` and ```RELEASE_NOTES.txt``` should be kept in sync as they refer
to the same release
+and provide a combined release notes over **all** versions.
+
+## RELEASE-NOTES.txt / RELEASE-NOTES-xyz.txt
+
+are release-specific notes that contain the contents of the release
announcement mail
+and are generated with the help of the maven-changes-plugin in RAT's repo.
+
+```
+$ ./mvnw changes:announcement-generate -Prelease-notes -Dchanges.version=0.17
+```
