diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 2bfb7ccdb27efdef9f9c2e248f9d0ba2ecc96541..287f62ebd56b4a371ff0db2f4899993616d4e6f7 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -114,6 +114,7 @@ full-dune-master-gcc-cpp-20: CXX_MAX_STANDARD: "20" DUMUX_ENABLE_CPPCHECK: "true" DUMUX_ENABLE_DOXYGEN_BUILD: "true" + DUMUX_CHECK_EXAMPLE_DOCS: "true" ################################## # additional scheduled pipelines # diff --git a/.gitlab-ci/default.yml b/.gitlab-ci/default.yml index 92112979e1f406e34c116ae684b519c1dff1c279..c1c66910fe5078df8a76f4d8dfa923fd554760a4 100644 --- a/.gitlab-ci/default.yml +++ b/.gitlab-ci/default.yml @@ -101,6 +101,24 @@ cppcheck: rules: - if: $DUMUX_ENABLE_CPPCHECK == "true" + +check-example-docs: + stage: linting + rules: + - if: $DUMUX_CHECK_EXAMPLE_DOCS == "true" + when: always + script: + - cd examples + - python3 generate_example_docs.py + - git diff . > example_diff.txt + - | + if [ -s example_diff.txt ]; then + cat example_diff.txt + echo "Example documentation is not up-to-date. Please rerun 'generate_example_docs.py'" + exit 1 + fi + + select tests: stage: select script: