Workflows

We make use of different Github workflows to automatically validate the code in this repository.

Linting

The Linting workflow contains the following checks:

  • ruff:
    Checks the format and style of the .py files in this repository, using the rules specified in pyproject.toml.

-pydoclint: Checks the docstring of the .py files in the rosw_ws/src directory, using the rules specified in pyproject.toml. These checks might be implemented in Ruff in the future, but for now we use pydoclint for the additional checks not available in Ruff.

  • clang-format:
    Checks the format of the .cpp, .h and .hpp files in this repository.

  • reuse:
    Checks all files in this repository on usage of copyright terms.

Local Development

You can run these checks locally before committing by using the pre-commit framework:

  1. Set it up in your working folder:

    pre-commit install

  2. (Optional) Run all hooks manually on all files:

    pre-commit run --all-files

This will help you catch issues early and avoid failing commits in CI.

Documentation

The Documentation workflow automatically builds HTML pages form the files in the docs folder of this repository using Sphinx. Next, the HTML pages are automatically pushed to the Github Pages of this repository.

Docker and Workspace

The Docker and Workspace workflow is the most extensive workflow of this repository. This workflow can also be tested locally using Act with the command:

act --rm -W .github/workflows/linting.yml

The workflow contains the following steps:

  • Check wether the workflow is executed on Github or locally.

  • Define the git branch in use.

  • Check wether files are changed in the dockerfiles directory compared to the main branch.

    • If changes are made, a new docker image gets build and pushed to the Docker Hub.

  • The correct docker image gets pulled and used to build the ros-workspace and run the tests using Pytest.