# ==================================================================================================================== #
# Authors:                                                                                                             #
#   Patrick Lehmann                                                                                                    #
#                                                                                                                      #
# ==================================================================================================================== #
# Copyright 2020-2024 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:
      python_version:
        description: 'Python version.'
        required: false
        default: '3.12'
        type: string
      directory:
        description: 'Source code directory to check.'
        required: true
        type: string
#      fail_below:
#        description: 'Minimum required documentation coverage level'
#        required: false
#        default: 75
#        type: string

jobs:
  DocCoverage:
    name: 👀 Check documentation coverage
    runs-on: ubuntu-latest
    steps:
      - name: ⏬ Checkout repository
        uses: actions/checkout@v4

      - name: 🐍 Setup Python 3.11
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: 🔧 Install wheel,tomli and pip dependencies (native)
        run: |
          python -m pip install --disable-pip-version-check -U docstr_coverage interrogate

      - name: Run 'interrogate' Documentation Coverage Check
        continue-on-error: true
        run: |
          interrogate -c pyproject.toml

      - name: Run 'docstr_coverage' Documentation Coverage Check
        continue-on-error: true
        run: |
          docstr_coverage -v ${{ inputs.directory }}