diff --git a/.github/workflows/CheckDocumentation.yml b/.github/workflows/CheckDocumentation.yml new file mode 100644 index 0000000..c092b5c --- /dev/null +++ b/.github/workflows/CheckDocumentation.yml @@ -0,0 +1,67 @@ +# ==================================================================================================================== # +# 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 ${{ inputs.python_version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ inputs.python_version }} + + - 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 }} diff --git a/.github/workflows/IntermediateCleanUp.yml b/.github/workflows/IntermediateCleanUp.yml new file mode 100644 index 0000000..4699446 --- /dev/null +++ b/.github/workflows/IntermediateCleanUp.yml @@ -0,0 +1,55 @@ +# ==================================================================================================================== # +# 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: Intermediate Cleanup + +on: + workflow_call: + inputs: + sqlite_coverage_artifacts_prefix: + description: 'Prefix for SQLite coverage artifacts' + required: false + type: string + xml_unittest_artifacts_prefix: + description: 'Prefix for XML unittest artifacts' + required: false + type: string + +jobs: + IntermediateCleanUp: + name: 🗑️ Intermediate Artifact Cleanup + runs-on: ubuntu-latest + steps: + - name: 🗑️ Delete SQLite coverage artifacts from matrix jobs + uses: geekyeggo/delete-artifact@v4 + if: inputs.sqlite_coverage_artifacts_prefix != '' + continue-on-error: true + with: + name: ${{ inputs.sqlite_coverage_artifacts_prefix }}* + token: ${{ secrets.GITHUB_TOKEN }} + + - name: 🗑️ Delete XML coverage artifacts from matrix jobs + uses: geekyeggo/delete-artifact@v4 + if: inputs.xml_unittest_artifacts_prefix != '' + continue-on-error: true + with: + name: ${{ inputs.xml_unittest_artifacts_prefix }}* + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/LaTeXDocumentation.yml b/.github/workflows/LaTeXDocumentation.yml new file mode 100644 index 0000000..c8b2dcc --- /dev/null +++ b/.github/workflows/LaTeXDocumentation.yml @@ -0,0 +1,65 @@ +# ==================================================================================================================== # +# 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: LaTeX Documentation + +on: + workflow_call: + inputs: + document: + description: 'LaTeX root document without *.tex extension.' + required: true + type: string + latex_artifact: + description: 'Name of the LaTeX documentation artifact.' + required: false + default: '' + type: string + pdf_artifact: + description: 'Name of the PDF documentation artifact.' + required: false + default: '' + type: string + +jobs: + PDFDocumentation: + name: 📓 Converting LaTeX Documentation to PDF + runs-on: ubuntu-latest + steps: + - name: 📥 Download artifacts '${{ inputs.latex_artifact }}' from 'SphinxDocumentation' job + uses: actions/download-artifact@v4 + with: + name: ${{ inputs.latex_artifact }} + path: latex + + - name: Compile LaTeX document + uses: xu-cheng/latex-action@master + with: + root_file: latex/${{ inputs.document }}.tex + + - name: 📤 Upload 'PDF Documentation' artifact + uses: actions/upload-artifact@v4 + if: inputs.pdf_artifact != '' + with: + name: ${{ inputs.pdf_artifact }} + path: ${{ inputs.document }}.pdf + if-no-files-found: error + retention-days: 1