[TASK] Use --minimal-test CLI option for documentation tests (#456)

This allows us to control specific settings needed for mininmal tests (like setting only a single output format) or more for the future. See also: TYPO3-Documentation/render-guides#765
TYPO3-Documentation · Oct 1, 2024 · 930e56b · 930e56b
1 parent b594596
commit 930e56b
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -14,4 +14,4 @@ jobs:
         run: |
           mkdir -p Documentation-GENERATED-temp \
           && docker run --rm --pull always -v $(pwd):/project \
-             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
+             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test
diff --git a/Documentation/Howto/RenderingDocs/Index.rst b/Documentation/Howto/RenderingDocs/Index.rst
@@ -178,7 +178,7 @@ documentation automatically:
                     run: |
                       mkdir -p Documentation-GENERATED-temp \
                       && docker run --rm --pull always -v $(pwd):/project \
-                         ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
+                         ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test
 
     .. group-tab:: GitLab
 
@@ -192,7 +192,7 @@ documentation automatically:
               stage: test
               script:
                 - mkdir -p Documentation-GENERATED-temp
-                - docker run --rm --pull always -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
+                - docker run --rm --pull always -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test
               tags:
                 - docker
 
diff --git a/Documentation/_CodeSnippets/_Makefile b/Documentation/_CodeSnippets/_Makefile
@@ -13,4 +13,4 @@ docs: ## Generate projects docs (from "Documentation" directory)
 .PHONY: test-docs
 test-docs: ## Test the documentation rendering
 	mkdir -p Documentation-GENERATED-temp
-	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test
diff --git a/Documentation/_CodeSnippets/_documentation.yml b/Documentation/_CodeSnippets/_documentation.yml
@@ -14,4 +14,4 @@ jobs:
         run: |
           mkdir -p Documentation-GENERATED-temp \
           && docker run --rm --pull always -v $(pwd):/project \
-             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
+             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test
diff --git a/Makefile b/Makefile
@@ -13,4 +13,4 @@ docs: ## Generate projects docs (from "Documentation" directory)
 .PHONY: test-docs
 test-docs: ## Test the documentation rendering
 	mkdir -p Documentation-GENERATED-temp
-	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test