Enhance CI / CD checks

[inf17101]

Description

The repository is constantly being expanded with further examples and tutorials. There are for example the control interface examples in various languages and the newly added user tutorial.

However, there are no active checks inside the CI / CD pipeline currently to prevent merging PRs that would break them.

In the future the examples, tutorials and documentations would grow and a contributor might be not aware of testing all the existing stuff manually before merging.

This shall be automated.

Goals

Having CI / CD checks on PR commits or at least nightly build checks allowing to see broken examples/tutorials to the right time point when merging a change that would break them. In addition, preferred is a solution that keeps performance and benefits in balance.

Final result

Summary

To be filled when the final solution is sketched.

Tasks

• Find a way to test the examples in Github actions
• Find a way to test the user tutorial in Github actions
• ...

[windsource]

I have just googled a bit about how to test the tutorials and found https://dev.to/agardnerit/automated-markdown-testing-two-options-d9. Maybe that helps. As an alternative we could use a system test for each tutorial but the problem would be about how to keep the system test in sync with the tutorial. That would be manual effort. But on the other hand a tutorial usually does not change, only the code does.