From df7cf39d3e972a216294de1643b58af50d7fb9bc Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 12 Jan 2024 14:12:14 +0100 Subject: [PATCH 1/4] Check documentation coverage. --- .github/workflows/CheckDocumenation.yml | 67 +++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 .github/workflows/CheckDocumenation.yml diff --git a/.github/workflows/CheckDocumenation.yml b/.github/workflows/CheckDocumenation.yml new file mode 100644 index 0000000..24c0d5e --- /dev/null +++ b/.github/workflows/CheckDocumenation.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 }} From 370e7ac1d921bb256e063f64b58d24e52e8f3c89 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 12 Jan 2024 14:12:32 +0100 Subject: [PATCH 2/4] Intermediate cleanups. --- .github/workflows/IntermediateCleanUp.yml | 55 +++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/workflows/IntermediateCleanUp.yml diff --git a/.github/workflows/IntermediateCleanUp.yml b/.github/workflows/IntermediateCleanUp.yml new file mode 100644 index 0000000..1210e11 --- /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 }} From 8ad5a861b4209bbaa0f73165a61490b901f3d7b8 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 12 Jan 2024 14:12:49 +0100 Subject: [PATCH 3/4] Compile LaTeX to PDF. --- .github/workflows/LaTeXDocumentation.yml | 65 ++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 .github/workflows/LaTeXDocumentation.yml 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 From 3920096e31dd65338d9182a9de8a441076af14d4 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 12 Jan 2024 14:23:04 +0100 Subject: [PATCH 4/4] Fixed prefix parameters and fixed typo in workflow name. --- .../{CheckDocumenation.yml => CheckDocumentation.yml} | 10 +++++----- .github/workflows/IntermediateCleanUp.yml | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) rename .github/workflows/{CheckDocumenation.yml => CheckDocumentation.yml} (95%) diff --git a/.github/workflows/CheckDocumenation.yml b/.github/workflows/CheckDocumentation.yml similarity index 95% rename from .github/workflows/CheckDocumenation.yml rename to .github/workflows/CheckDocumentation.yml index 24c0d5e..c092b5c 100644 --- a/.github/workflows/CheckDocumenation.yml +++ b/.github/workflows/CheckDocumentation.yml @@ -33,11 +33,11 @@ on: description: 'Source code directory to check.' required: true type: string - fail_below: - description: 'Minimum required documentation coverage level' - required: false - default: 75 - type: string +# fail_below: +# description: 'Minimum required documentation coverage level' +# required: false +# default: 75 +# type: string jobs: DocCoverage: diff --git a/.github/workflows/IntermediateCleanUp.yml b/.github/workflows/IntermediateCleanUp.yml index 1210e11..4699446 100644 --- a/.github/workflows/IntermediateCleanUp.yml +++ b/.github/workflows/IntermediateCleanUp.yml @@ -43,7 +43,7 @@ jobs: if: inputs.sqlite_coverage_artifacts_prefix != '' continue-on-error: true with: - name: ${{ inputs.sqlite_coverage_artifacts_prefix }}-* + name: ${{ inputs.sqlite_coverage_artifacts_prefix }}* token: ${{ secrets.GITHUB_TOKEN }} - name: 🗑️ Delete XML coverage artifacts from matrix jobs @@ -51,5 +51,5 @@ jobs: if: inputs.xml_unittest_artifacts_prefix != '' continue-on-error: true with: - name: ${{ inputs.xml_unittest_artifacts_prefix }}-* + name: ${{ inputs.xml_unittest_artifacts_prefix }}* token: ${{ secrets.GITHUB_TOKEN }}