Doc-coverage.yml

name: Build Documentation Coverage

on: [push, pull_request]

jobs:
  build-doxygen-docs:
    uses: ./.github/workflows/doxygen-build.yml

  build:
    runs-on: ubuntu-latest
    needs: build-doxygen-docs
    permissions:
      contents: write
    defaults:
      run:
        working-directory: ./doc
    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'

    - name: Install python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install coverxygen

    - name: Restore Doxygen Output Cache
      uses: actions/cache@v3
      id: doxygen-output-cache
      with:
        path: |
          doxygenOut/html
          doxygenOut/xml
        key: ${{ github.ref }}-doxygen-output

    - name: Run coverxygen
      run: python3 -m coverxygen --format summary --xml-dir doxygenOut/xml/ --src-dir .. --output doc-coverage.info
    
    - name: Print doc coverage
      run: cat doc-coverage.info