Skip to content

Commit

Permalink
[TASK] Use --minimal-test CLI option for documentation tests
Browse files Browse the repository at this point in the history
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
  • Loading branch information
linawolf committed Oct 1, 2024
1 parent b594596 commit ddacb48
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions Documentation/Howto/RenderingDocs/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
2 changes: 1 addition & 1 deletion Documentation/_CodeSnippets/_Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion Documentation/_CodeSnippets/_documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit ddacb48

Please sign in to comment.