Skip to content

Commit

Permalink
[DOCS] workaround for version matrix
Browse files Browse the repository at this point in the history 
Currently it is not possible to use spans in tables, like it was possible on Sphix-Variant.
See: phpDocumentor/guides#1187

On the test `test_documentation` CI job, we want to generate the docs twice to be able to recognize the errors and warnings in the docs.
See: phpDocumentor/guides#1188

Fixes: #4204
  • Loading branch information
@dkd-kaehm
dkd-kaehm committed Dec 12, 2024
1 parent 4f7b9a7 commit bc5bf0b
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 48 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,6 @@ jobs:
test_documentation:
name: test Documentation
runs-on: ubuntu-latest
## @todo: remove `continue-on-error: true`, if Version matrix tables are fixed.
continue-on-error: true
steps:
# Workaround for issue with actions/checkout "wrong PR commit checkout". See: ci_bootstrapping job
- name: Checkout current state of Pull Request
Expand All @@ -106,7 +104,7 @@ jobs:

- name: Test if the documentation will render without warnings
run: |
Build/generate_documentation.sh --no-progress --minimal-test
Build/generate_documentation.sh --no-progress
tests:
runs-on: ubuntu-latest
Expand Down
9 changes: 8 additions & 1 deletion Build/generate_documentation.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@ if ! command -v docker &> /dev/null; then
exit 1
fi

if ! docker run --rm --pull always -v "$(pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation "$@"; then
# @todo: Don't run the command twice: https://github.com/phpDocumentor/guides/issues/1188
if ! docker run --rm --pull always -v "$(pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest \
--config=Documentation \
--fail-on-error "$@" \
|| ! docker run --rm --pull always -v "$(pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest \
--config=Documentation \
--fail-on-log "$@"
then
echo "Something went wrong on rendering the docs. Please check the output and affected documentation files of EXT:solr and fix them."
exit 1;
else
Expand Down
89 changes: 45 additions & 44 deletions Documentation/Appendix/VersionMatrix.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ Supported versions

List of EXT:solr versions and the matching versions of Apache Solr and TYPO3 that are supported:

========= ========== ========== =========== =============== ================== ================================ =============== =============== =================
Basic components Funding contribution extensions Published funding contribution Extensions Solr configuration
------------------------------- ---------------------------------------------- -------------------------------- --------------- ---------------------------------
TYPO3 EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrdebugtools EXT:solrfluidgrouping EXT:solrmlt Apache Solr Configset
========= ========== ========== =========== =============== ================== ================================ =============== =============== =================
13.4 13.0 (ᾱ) 13.0 (Ø) 13.0 (ᾱ) 13.0 (Ø) 13.0 (Ø) N/A (integrated in EXT:solr) 13.0 (Ø) 9.7.0¹ ext_solr_13_0_0
12.4 12.0 12.0 12.0 12.0 12.0 N/A (integrated in EXT:solr) 12.0 (Ø) 9.7.0¹ ext_solr_12_0_0
========= ========== ========== =========== =============== ================== ================================ =============== =============== =================

========= ============= ================ ============= ================= ==================== ======================= ================================ =============== =================
TYPO3 EXT:solr (↻) EXT:solrmlt (↻) EXT:tika (↻) EXT:solrfal ($) EXT:solrconsole ($) EXT:solrdebugtools ($) EXT:solrfluidgrouping ($↺) Apache Solr Configset
========= ============= ================ ============= ================= ==================== ======================= ================================ =============== =================
13.4 13.0 (ᾱ) 13.0 (Ø) 13.0 (Ø) 13.0 (ᾱ) 13.0 (Ø) 13.0 (Ø) N/A (integrated in EXT:solr) 9.7.0¹ ext_solr_13_0_0
12.4 12.0 12.0 (Ø) 12.0 12.0 12.0 12.0 N/A (integrated in EXT:solr) 9.7.0¹ ext_solr_12_0_0
========= ============= ================ ============= ================= ==================== ======================= ================================ =============== =================

| $ - Funding contribution extensions. See: https://www.typo3-solr.com/solr-for-typo3/open-source-version/
| $↺ - Published funding contribution. Previously as ($), but mergen in EXT:solr core
| ↻ - Open Source and financed by ($)
| Ø - not yet available
| ᾱ - non stable alpha release
| β - non stable beta release
Expand All @@ -35,51 +36,51 @@ Extended Long Term Support (ELTS)
Since January 2022, we have been following the TYPO3 release cycles and actively support the last two TYPO3 versions; in addition, we offer ELTS support for
selected older versions. The following table illustrates the offers and available and upcoming versions:

========= =========== ========== =========== =============== ================== =============== ====================
Basic components Funding contribution extensions Solr configuration
-------------------------------- ---------------------------------------------- ------------------------------------
TYPO3 EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrdebugtools Apache Solr Configset
========= =========== ========== =========== =============== ================== =============== ====================
11.5 ELTS 11.6.1+ (Ø) 11.0 11.0 11.0 11.0 9.7.0¹ ext_solr_11_6_0_elts
10.4 ELTS 11.2.4+ 10.0 10.0 10.0 10.0 9.5.0¹ ext_solr_11_2_0_elts
========= =========== ========== =========== =============== ================== =============== ====================
=========== =========== ========== =========== =============== ================== =============== ====================
TYPO3 ELTS EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrdebugtools Apache Solr Configset
=========== =========== ========== =========== =============== ================== =============== ====================
11.5 11.6.1+ (Ø) 11.0 11.0 11.0 11.0 9.7.0¹ ext_solr_11_6_0_elts
10.4 11.2.4+ 10.0 10.0 10.0 10.0 9.5.0¹ ext_solr_11_2_0_elts
=========== =========== ========== =========== =============== ================== =============== ====================

Our Apache Solr for TYPO3 EB-partners newsletter will keep you updated!

| $ - Funding contribution extensions as ELTS. See: ELTS on https://shop.dkd.de/produkte/apache-solr-fuer-typo3/
| ELTS - In Extended program. See: https://typo3.com/services/extended-support-elts
| Ø - not yet available
| ¹ - recommended Apache Solr version, check version matrix in composer.json (`composer info:solr-versions`) for full list
No longer supported versions
----------------------------

========= ========== ========= =========== =============== ================== =========== =========== ======================================
TYPO3 EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrdebugtools EXT:solrmlt Apache Solr Configset
========= ========== ========= =========== =============== ================== =========== =========== ======================================
11.5 11.6.0 11.0 11.0 11.0 11.0 N/A 9.7 ext_solr_11_6_0
11.5 11.5.0-7 11.0 11.0 11.0 11.0 N/A 8.11 ext_solr_11_5_0
10.4 11.2.0-3 10.0 10.0 10.0 10.0 10.0 8.11 ext_solr_11_2_0
10.4 11.2.0-3 10.0 10.0 10.0 10.0 10.0 8.11 ext_solr_11_2_0
10.4 11.1 10.0 10.0 10.0 10.0 10.0 8.9 ext_solr_11_1_0
9.5-10.4 11.0.0-9 6.0.0-3 8.0.0-1 4.0.0-1 1.1.2 3.1 8.5 ext_solr_11_0_0, ext_solr_11_0_0_elts
========= ========== ========= =========== =============== ================== =========== =========== ======================================
========= ========== ========= =========== =============== ================== =========== =========== ======================================
TYPO3 EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrdebugtools EXT:solrmlt Apache Solr Configset
========= ========== ========= =========== =============== ================== =========== =========== ======================================
11.5 11.6.0 11.0 11.0 11.0 11.0 N/A 9.7 ext_solr_11_6_0
11.5 11.5.0-7 11.0 11.0 11.0 11.0 N/A 8.11 ext_solr_11_5_0
10.4 11.2.0-3 10.0 10.0 10.0 10.0 10.0 8.11 ext_solr_11_2_0
10.4 11.2.0-3 10.0 10.0 10.0 10.0 10.0 8.11 ext_solr_11_2_0
10.4 11.1 10.0 10.0 10.0 10.0 10.0 8.9 ext_solr_11_1_0
9.5-10.4 11.0.0-9 6.0.0-3 8.0.0-1 4.0.0-1 1.1.2 3.1 8.5 ext_solr_11_0_0, ext_solr_11_0_0_elts
========= ========== ========= =========== =============== ================== =========== =========== ======================================

Obsolete versions
-----------------

========== ========= ========= =========== =============== ===================== ================== ============= ================ =========== =========== ======================== ========================= ============
TYPO3 EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrfluidgrouping EXT:solrdebugtools EXT:solrfluid EXT:solrgrouping EXT:solrmlt Apache Solr Schema Solrconfig Accessplugin
========== ========= ========= =========== =============== ===================== ================== ============= ================ =========== =========== ======================== ========================= ============
9.5 10.0 5.0 7.0 4.0 2.0 1.1.2 N/A N/A 3.0 8.2.0 tx_solr-10-0-0--20191010 tx_solr-10-0-0--20191010 4.0
8.7 - 9.5 9.0 4.0 6.0 2.0 2.0 1.0.0-1.1.1 N/A N/A 3.0 7.6.0 tx_solr-9-0-0--20180727 tx_solr-9-0-0--20180727 3.0
8.7 8.1 3.1 5.1 1.0 1.1 1.0.0-1.1.1 N/A N/A 2.0 6.6.3 tx_solr-8-1-0--20180615 tx_solr-8-1-0--20180615 2.0
8.7 8.0 3.0 5.0 N/A 1.0 1.0.0-1.1.1 N/A N/A N/A 6.6.2 tx_solr-8-0-0--20171020 tx_solr-8-0-0--20171020 2.0
8.7 7.5 2.4 4.2 N/A N/A 1.0.0-1.1.1 N/A N/A N/A 6.6.2 tx_solr-7-5-0--20171023 tx_solr-7-5-0--20171023 2.0
8.7 7.0 2.4 4.2 N/A N/A 1.0.0-1.1.1 N/A N/A N/A 6.3 tx_solr-7-0-0--20170530 tx_solr-7-0-0--20170530 2.0
7.6 - 8.x 6.5 2.3 4.1 N/A N/A N/A 2.0 1.3 N/A 6.6.2 tx_solr-6-5-0--20171023 tx_solr-6-5-0--20171023 2.0
7.6 - 8.7 6.1 2.3 4.1 N/A N/A N/A 2.0 1.3 N/A 6.3 tx_solr-6-1-0--20170206 tx_solr-6-1-0--20161220 2.0
7.6 6.0 2.2 4.0 N/A N/A N/A 1.2 1.3 N/A 6.3 tx_solr-6-0-0--20161209 tx_solr-6-0-0--20161122 1.7
7.6 5.1 2.1 3.2 N/A N/A N/A 1.2 1.3 N/A 4.10 tx_solr-5-1-0--20160725 tx_solr-4-0-0--20160406 1.3
7.6 5.0 2.1 3.1 N/A N/A N/A 1.0 1.3 N/A 4.10 tx_solr-4-0-0--20160406 tx_solr-4-0-0--20160406 1.3
7.6 4.0 2.1 3.0 N/A N/A N/A N/A 1.2 N/A 4.10 tx_solr-4-0-0--20160406 tx_solr-4-0-0--20160406 1.3
6.2 - 7.6 3.1 2.0 2.1 N/A N/A N/A N/A 1.1 1.1 4.10 tx_solr-3-1-0--20150614 tx_solr-3-1-0--20151012 1.3
========== ========= ========= =========== =============== ===================== ================== ============= ================ =========== =========== ======================== ========================= ============
========== ========= ========= =========== =============== ===================== ================== ============= ================ =========== =========== ======================== ========================= ============
TYPO3 EXT:solr EXT:tika EXT:solrfal EXT:solrconsole EXT:solrfluidgrouping EXT:solrdebugtools EXT:solrfluid EXT:solrgrouping EXT:solrmlt Apache Solr Schema Solrconfig Accessplugin
========== ========= ========= =========== =============== ===================== ================== ============= ================ =========== =========== ======================== ========================= ============
9.5 10.0 5.0 7.0 4.0 2.0 1.1.2 N/A N/A 3.0 8.2.0 tx_solr-10-0-0--20191010 tx_solr-10-0-0--20191010 4.0
8.7 - 9.5 9.0 4.0 6.0 2.0 2.0 1.0.0-1.1.1 N/A N/A 3.0 7.6.0 tx_solr-9-0-0--20180727 tx_solr-9-0-0--20180727 3.0
8.7 8.1 3.1 5.1 1.0 1.1 1.0.0-1.1.1 N/A N/A 2.0 6.6.3 tx_solr-8-1-0--20180615 tx_solr-8-1-0--20180615 2.0
8.7 8.0 3.0 5.0 N/A 1.0 1.0.0-1.1.1 N/A N/A N/A 6.6.2 tx_solr-8-0-0--20171020 tx_solr-8-0-0--20171020 2.0
8.7 7.5 2.4 4.2 N/A N/A 1.0.0-1.1.1 N/A N/A N/A 6.6.2 tx_solr-7-5-0--20171023 tx_solr-7-5-0--20171023 2.0
8.7 7.0 2.4 4.2 N/A N/A 1.0.0-1.1.1 N/A N/A N/A 6.3 tx_solr-7-0-0--20170530 tx_solr-7-0-0--20170530 2.0
7.6 - 8.x 6.5 2.3 4.1 N/A N/A N/A 2.0 1.3 N/A 6.6.2 tx_solr-6-5-0--20171023 tx_solr-6-5-0--20171023 2.0
7.6 - 8.7 6.1 2.3 4.1 N/A N/A N/A 2.0 1.3 N/A 6.3 tx_solr-6-1-0--20170206 tx_solr-6-1-0--20161220 2.0
7.6 6.0 2.2 4.0 N/A N/A N/A 1.2 1.3 N/A 6.3 tx_solr-6-0-0--20161209 tx_solr-6-0-0--20161122 1.7
7.6 5.1 2.1 3.2 N/A N/A N/A 1.2 1.3 N/A 4.10 tx_solr-5-1-0--20160725 tx_solr-4-0-0--20160406 1.3
7.6 5.0 2.1 3.1 N/A N/A N/A 1.0 1.3 N/A 4.10 tx_solr-4-0-0--20160406 tx_solr-4-0-0--20160406 1.3
7.6 4.0 2.1 3.0 N/A N/A N/A N/A 1.2 N/A 4.10 tx_solr-4-0-0--20160406 tx_solr-4-0-0--20160406 1.3
6.2 - 7.6 3.1 2.0 2.1 N/A N/A N/A N/A 1.1 1.1 4.10 tx_solr-3-1-0--20150614 tx_solr-3-1-0--20151012 1.3
========== ========= ========= =========== =============== ===================== ================== ============= ================ =========== =========== ======================== ========================= ============

0 comments on commit bc5bf0b

Please sign in to comment.