Skip to content

Feature/ci test example up to dateness

Dennis Gläser requested to merge feature/ci-test-example-up-to-dateness into master

What this MR does / why does DuMux need it:

Adds the generation of the example documentation to the CI, verifying that it is in sync with the corresponding sources. This detects if either an example's README file was modified instead of the sources, or, if the documentation was not regenerated and committed.

Before you request a review from someone, make sure to revise the following points:

  • does the new code follow the style guide?
  • do the test pipelines pass? (see guide on how to run pipelines for a merge request)
  • is the code you changed and/or the new code you wrote covered in the test suite? (if not, extend the existing tests or write new ones)
  • does your change affect public interfaces or behavior, or, does it introduce a new feature? If so, document the change in
  • is the list of the header includes complete? ("include what you use")
  • all files have to end with a \n character. Make sure there is no \ No newline at end of file comment in "Changes" of this MR.
Edited by Dennis Gläser

Merge request reports