From 1ad14ad9e690292b3641fac401938cb25b70df3f Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Tue, 1 Oct 2024 19:18:53 +0200 Subject: [PATCH] [TASK] Use --minimal-test CLI option for documentation tests (#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: https://github.com/TYPO3-Documentation/render-guides/pull/765 Releases: main, 12.4, 11.5 (cherry picked from commit 6ae38ac26c4f03160060024e4cad0cf11ee6bee1) --- .github/workflows/documentation.yml | 17 +++++++++++++++++ Makefile | 22 +--------------------- 2 files changed, 18 insertions(+), 21 deletions(-) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..10cc6d5f --- /dev/null +++ b/.github/workflows/documentation.yml @@ -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 diff --git a/Makefile b/Makefile index 587ec228..a32d86c0 100644 --- a/Makefile +++ b/Makefile @@ -9,28 +9,8 @@ docs: ## Generate projects docs (from "Documentation" directory) docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation -.PHONY: codesnippets -codesnippets: ## Regenerate automatic code snippets - .Build/vendor/bin/typo3 codesnippet:create Documentation/CodeSnippets/ - -.PHONY: test -test: test-lint test-cgl test-docs ## Runs all test suites - -.PHONY: test-lint -test-lint: ## Lint PHP includes - Build/Scripts/runTests.sh -s lint - -.PHONY: test-cgl -test-cgl: ## Test coding guidelines to PHP includes - Build/Scripts/runTests.sh -n -s cgl - -.PHONY: fix-cgl -fix-cgl: ## Apply coding guidelines to PHP includes - Build/Scripts/runTests.sh -s cgl - .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 --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