# ==================================================================================================================== #
# Authors:                                                                                                             #
#   Patrick Lehmann                                                                                                    #
#                                                                                                                      #
# ==================================================================================================================== #
# Copyright 2020-2025 The pyTooling Authors                                                                            #
#                                                                                                                      #
# Licensed under the Apache License, Version 2.0 (the "License");                                                      #
# you may not use this file except in compliance with the License.                                                     #
# You may obtain a copy of the License at                                                                              #
#                                                                                                                      #
#   http://www.apache.org/licenses/LICENSE-2.0                                                                         #
#                                                                                                                      #
# Unless required by applicable law or agreed to in writing, software                                                  #
# distributed under the License is distributed on an "AS IS" BASIS,                                                    #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.                                             #
# See the License for the specific language governing permissions and                                                  #
# limitations under the License.                                                                                       #
#                                                                                                                      #
# SPDX-License-Identifier: Apache-2.0                                                                                  #
# ==================================================================================================================== #
name: Check Documentation

on:
  workflow_call:
    inputs:
      ubuntu_image_version:
        description: 'Ubuntu image version.'
        required: false
        default: '24.04'
        type: string
      python_version:
        description: 'Python version.'
        required: false
        default: '3.13'
        type: string
      directory:
        description: 'Source code directory to check.'
        required: true
        type: string
      fail_under:
        description: 'Minimum required documentation coverage level'
        required: false
        default: '80'
        type: string

jobs:
  DocCoverage:
    name: 👀 Check documentation coverage
    runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}"
    steps:
      - name: ⏬ Checkout repository
        uses: actions/checkout@v5

      - name: 🐍 Setup Python ${{ inputs.python_version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ inputs.python_version }}

      - name: 🔧 Install docstr_coverage and interrogate dependencies
        run: |
          python -m pip install --disable-pip-version-check -U docstr_coverage interrogate[png]

      - name: Run 'interrogate' Documentation Coverage Check
        continue-on-error: true
        run: |
          set +e

          interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
          if [[ $? -ne 0 ]]; then
            printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
          fi

      - name: Run 'docstr_coverage' Documentation Coverage Check
        continue-on-error: true
        run: |
          set +e

          docstr-coverage --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
          if [[ $? -ne 0 ]]; then
            printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
          fi
