[DOC] Fix changelogs and add hints about outdated state on branches

The changelog is a single file, each major version. This change allows us to avoid porting of changelog files across release-zz.y branches. Most probably we'll introduce single file - each commit changelog approach to avoid all the problems related to our current approach. Relates: TYPO3-Solr#3854 Ports: TYPO3-Solr#3863
dkd-kaehm · Nov 8, 2023 · 9432ac8 · 9432ac8
1 parent 4a640c1
commit 9432ac8
Show file tree

Hide file tree

Showing 10 changed files with 686 additions and 92 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -27,7 +27,7 @@ If applicable, add screenshots to help explain your problem.
  - TYPO3 Version: [e.g. 12.4.0]
  - Browser: [e.g. chrome, safari]
  - EXT:solr Version: [e.g. 12.0.0]
- - Used Apache Solr Version: [e.g. 9.3.0]
+ - Used Apache Solr Version: [e.g. 9.3.1]
  - PHP Version: [e.g. 8.2.0]
  - MySQL Version: [e.g. 8.0.0]
 

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -70,8 +70,6 @@ jobs:
           echo -e "matrix : "
           echo $matrix
           echo "matrix=$(echo $matrix)" >> $GITHUB_OUTPUT
-          >&2 echo -e "Example Annotation on error. Is visible in Actions workflow view."
-          >&2 echo -e "Non-stable releases can not be published to TER. The tags containing beta-1 is invalid for TER."
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2

diff --git a/Documentation/FAQ/Index.rst b/Documentation/FAQ/Index.rst
diff --git a/Documentation/Releases/HintAboutOutdatedChangelog.rst.txt b/Documentation/Releases/HintAboutOutdatedChangelog.rst.txt
@@ -0,0 +1,5 @@
+..  attention::
+
+     You are on docs for EXT:solr |release| version.
+     This file may be outdated if you are on wrong release "branch" version.
+     To get the most recent changelog, please choose on the top left dropdown menu the version you are looking for.
diff --git a/Documentation/Releases/Index.rst b/Documentation/Releases/Index.rst
@@ -14,6 +14,7 @@ Releases
     :glob:
 
     new-releases
+    solr-release-12-0
     solr-release-11-6
     solr-release-11-2
     solr-release-11-0

diff --git a/Documentation/Releases/solr-release-10-0.rst b/Documentation/Releases/solr-release-10-0.rst
@@ -2,9 +2,12 @@
 ..  index:: Archive
 .. _releases-10:
 
-==============
-Release 10.0.0
-==============
+=============
+Releases 10.0
+=============
+
+..  include:: HintAboutOutdatedChangelog.rst.txt
+
 
 We are happy to release EXT:solr 10.0.0.
 The focus of EXT:solr 10.0.0 was, to support the `site handling <https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/ApiOverview/SiteHandling/Index.html />`_ that was introduced in TYPO3 9 LTS .

diff --git a/Documentation/Releases/solr-release-11-0.rst b/Documentation/Releases/solr-release-11-0.rst
@@ -2,9 +2,14 @@
 ..  index:: Releases
 .. _releases-11:
 
-==============
+=============
+Releases 11.0
+=============
+
+..  include:: HintAboutOutdatedChangelog.rst.txt
+
 Release 11.0.8
-==============
+--------------
 
 We are happy to release EXT:solr 11.0.8 maintenance release, this release is a non-public ELTS release.
 

diff --git a/Documentation/Releases/solr-release-11-2.rst b/Documentation/Releases/solr-release-11-2.rst
@@ -1,11 +1,16 @@
 ..  include:: /Includes.rst.txt
 ..  index:: Releases
-
 .. _releases-11-2:
 
-==============
+=============
+Releases 11.2
+=============
+
+..  include:: HintAboutOutdatedChangelog.rst.txt
+
+
 Release 11.2.2
-==============
+--------------
 
 This is a maintenance release for TYPO3 10.4 and the last non ELTS release, as TYPO3 10 LTS reaches the ELTS phase on April 30, 2023.
 
@@ -65,9 +70,6 @@ Release 11.2.0
 We are happy to release EXT:solr 11.2.0.
 The focus of this release has been on supporting the latest Apache Solr version 8.11.1 and on optimizing the data update monitoring.
 
-New in this release
--------------------
-
 Apache Solr 8.11.1 support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/Documentation/Releases/solr-release-11-5.rst b/Documentation/Releases/solr-release-11-5.rst
@@ -2,9 +2,18 @@
 ..  index:: Archive
 .. _releases-11-5:
 
-==============
+=============
+Releases 11.5
+=============
+
+..  include:: HintAboutOutdatedChangelog.rst.txt
+
+
 Release 11.5.3
-==============
+--------------
+
+Release 11.5.2
+--------------
 
 This is a maintenance release for TYPO3 11.5, containing:
 

diff --git a/Documentation/Releases/solr-release-12-0.rst b/Documentation/Releases/solr-release-12-0.rst