Write GitHub errors for documentation checks.

This commit is contained in:
Patrick Lehmann
2024-08-05 23:05:56 +02:00
parent 440553e7fb
commit cea83bc2ae
5 changed files with 8 additions and 6 deletions

View File

@@ -59,9 +59,9 @@ jobs:
- name: Run 'interrogate' Documentation Coverage Check - name: Run 'interrogate' Documentation Coverage Check
continue-on-error: true continue-on-error: true
run: | run: |
interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && echo "::error title=interrogate::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
- name: Run 'docstr_coverage' Documentation Coverage Check - name: Run 'docstr_coverage' Documentation Coverage Check
continue-on-error: true continue-on-error: true
run: | run: |
docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} && echo "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"

View File

@@ -155,7 +155,9 @@ jobs:
- name: 🔧 Install apt dependencies on Ubuntu - name: 🔧 Install apt dependencies on Ubuntu
if: matrix.system == 'ubuntu' && inputs.apt != '' if: matrix.system == 'ubuntu' && inputs.apt != ''
run: sudo apt-get install -y --no-install-recommends ${{ inputs.apt }} run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends ${{ inputs.apt }}
# Compute Dependencies for MSYS2 steps # Compute Dependencies for MSYS2 steps

View File

@@ -1,2 +1,2 @@
wheel ~= 0.43 wheel ~= 0.44
twine ~= 5.1 twine ~= 5.1

View File

@@ -1,7 +1,7 @@
[build-system] [build-system]
requires = [ requires = [
"setuptools ~= 72.1", "setuptools ~= 72.1",
"wheel ~= 0.43", "wheel ~= 0.44",
"pyTooling ~= 6.5" "pyTooling ~= 6.5"
] ]
build-backend = "setuptools.build_meta" build-backend = "setuptools.build_meta"

View File

@@ -68,7 +68,7 @@ data = {
}, },
# Runner systems (runner images) supported by GitHub Actions # Runner systems (runner images) supported by GitHub Actions
"sys": { "sys": {
"ubuntu": {"icon": "🐧", "runs-on": "ubuntu-2024.04", "shell": "bash", "name": "Linux (x86-64)"}, "ubuntu": {"icon": "🐧", "runs-on": "ubuntu-24.04", "shell": "bash", "name": "Linux (x86-64)"},
"windows": {"icon": "🪟", "runs-on": "windows-latest", "shell": "pwsh", "name": "Windows (x86-64)"}, "windows": {"icon": "🪟", "runs-on": "windows-latest", "shell": "pwsh", "name": "Windows (x86-64)"},
"macos": {"icon": "🍎", "runs-on": "macos-latest-large", "shell": "bash", "name": "macOS (x86-64)"}, "macos": {"icon": "🍎", "runs-on": "macos-latest-large", "shell": "bash", "name": "macOS (x86-64)"},
"macos-arm": {"icon": "🍏", "runs-on": "macos-latest", "shell": "bash", "name": "macOS (arm64)"}, "macos-arm": {"icon": "🍏", "runs-on": "macos-latest", "shell": "bash", "name": "macOS (arm64)"},