Skip to content

Commit

Permalink
[CI] Speed up documentation check (#4777)
Browse files Browse the repository at this point in the history
It is sufficient to check check one output format for errors.
With this patch we gain a massive performance improvement, resulting also in less processor cycles and therefore less energy consumption.

Previously, on documentation testing (locally):

    Parsing: 814/814 [============================] 100% Parsed 814 files in 17.35 seconds
    Rendering: 814/814 [===========] 100% Output format html: Rendered 814 documents in 48.17 seconds
    Rendering: 814/814 [============================] 100% Output format singlepage: Rendered 814 documents in 3.51 seconds
    Rendering: 814/814 [============================] 100% Output format interlink: Rendered 814 documents in 0.05 seconds
    Successfully placed 814 rendered HTML, SINGLEPAGE, and INTERLINK files into /project/Documentation-GENERATED-temp

With this patch (locally):

    Parsing: 814/814 [============================] 100% Parsed 814 files in 17.71 seconds
    Rendering: 814/814 [============================] 100% Output format singlepage: Rendered 814 documents in 8.24 seconds
    Successfully placed 814 rendered SINGLEPAGE files into /project/Documentation-GENERATED-temp

Releases: main, 12.4
  • Loading branch information
brotkrueml authored Sep 24, 2024
1 parent 3873905 commit d539a10
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .github/workflows/test-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,8 @@ 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 \
--output-format=singlepage \
--no-progress \
--fail-on-log

0 comments on commit d539a10

Please sign in to comment.