docstring_check.yaml

name: docstring-check
on: [pull_request, push]

jobs:
  build:
    name: docstring-check
    runs-on: ubuntu-20.04
    # Run on external PRs, but not internal PRs as they'll be run by the push
    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository

    steps:
        - name: Fetch repository
          uses: actions/checkout@v3
          with:
            submodules: recursive

        - name: Install packages
          run: |
            sudo apt-get update
            sudo apt-get install build-essential libhdf5-dev python3-venv libclang1-9

            # debug
            dpkg -L libclang1-9
            ls -al /usr/lib/x86_64-linux-gnu/libclang*

        - name: Check docstrings
          run: |
            export LIBCLANG_PATH=/usr/lib/x86_64-linux-gnu/libclang-9.so.1
            ci/check_generated_docstrings.sh || true