Skip to content

Build: Teach build system to build Doxygen docs #1478

Build: Teach build system to build Doxygen docs

Build: Teach build system to build Doxygen docs #1478

name: Formatting check
on:
pull_request:
types:
- "opened"
- "reopened"
- "synchronize"
- "labeled"
- "unlabeled"
jobs:
cpp_formatting_check:
name: C++ Formatting Check
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: clang-format style check
run: |
git clang-format-18 --diff -q origin/main | tee format_diff.txt
if [ -s format_diff.txt ]; then exit 1; fi
python_formatting_check:
# There might be differences how the formatter refactors the code locally
# and in the CI. If there is a problem with CI formatter mismatch, consider
# wrapping a troublesome python code with comments:
# "# fmt: off"
# "<Python code we don't want to format>"
# "# fmt: on"
name: Python Formatting Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
# TODO black no longer runs on 3.12.5.
# Remove once the python version is >= 3.12.6
# See: https://github.com/psf/black/pull/4447
python-version: '3.12.4'
- name: black style check
run: |
pip3 install git+https://github.com/psf/black
black .
git diff -q | tee format_diff.txt
if [ -s format_diff.txt ]; then exit 1; fi