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: TYPO3-Solr#4204
  • Loading branch information
dkd-kaehm committed Dec 12, 2024
1 parent 4f7b9a7 commit a14032e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/ci.yml
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
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

0 comments on commit a14032e

Please sign in to comment.