Skip to content

Commit

Permalink
[TASK] Add a testing workflow (#168)
Browse files Browse the repository at this point in the history
And fix warnings
  • Loading branch information
linawolf authored Oct 1, 2024
1 parent 4cb8b8d commit cd9e130
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 3 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/test-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
2 changes: 1 addition & 1 deletion Documentation/Exceptions/1257246929.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Problem: Using an Extbase link with argument "format"

When creating a link like:

.. code-block:: fluid
.. code-block:: html

<f:uri.action action="new" arguments="{format: someFormat}" />
<f:uri.action action="new" format="{someFormat}" />
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Exceptions/1705656657.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ This exception is triggered if you attempt to view a page that lacks a TypoScrip
Solution
--------

:ref:`Create a TypoScript template <t3ts45:the-main-template>` for your site in the site's root page.
:ref:`Create a TypoScript template <t3sitepackage:typoscript-configuration>` for your site in the site's root page.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ 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 cd9e130

Please sign in to comment.