Skip to content

Commit

Permalink
[TASK] styleguide: Use --minimal-test CLI option for documentation te…
Browse files Browse the repository at this point in the history
…sts (#547)

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

(cherry picked from commit 6ae38ac26c4f03160060024e4cad0cf11ee6bee1)
  • Loading branch information
linawolf committed Oct 1, 2024
1 parent bfc3623 commit 70277b5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
17 changes: 17 additions & 0 deletions Documentation/TSconfig/.github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: test documentation

on: [ push, pull_request ]

jobs:
tests:
name: documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Test if the documentation will render without warnings
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 --minimal-test
3 changes: 1 addition & 2 deletions Documentation/TSconfig/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ help: ## Displays this list of targets with descriptions
@echo "The following commands are available:\n"
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'


.PHONY: docs
docs: ## Generate projects docs (from "Documentation" directory)
mkdir -p Documentation-GENERATED-temp
Expand All @@ -14,4 +13,4 @@ docs: ## Generate projects docs (from "Documentation" directory)
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 --output-format=html
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 70277b5

Please sign in to comment.