Skip to content

Commit

Permalink
[TASK] Use --minimal-test CLI option for documentation tests (#172)
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

Releases: main, 12.4, 11.5

Co-authored-by: lina.wolf <[email protected]>
  • Loading branch information
github-actions[bot] and linawolf committed Oct 1, 2024
1 parent 5cd1f3b commit 0fcf682
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
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
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,10 @@ docs: ## Generate projects docs (from "Documentation" directory)
mkdir -p Documentation-GENERATED-temp

docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation

.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 --minimal-test

0 comments on commit 0fcf682

Please sign in to comment.