Update documentation according to latest changes.

This commit is contained in:
Patrick Lehmann
2025-09-22 09:19:09 +02:00
parent 8ecefcec59
commit f684e67bca
12 changed files with 1240 additions and 726 deletions

View File

@@ -90,6 +90,10 @@ jobs:
mkdir -p report/bandit
bandit -c pyproject.toml -r ${{ inputs.package_directory }} -f xml -o report/bandit/report.xml
- name: Debug
run: |
cat report/bandit/report.xml
- name: 📊 Publish Bandit Results
uses: dorny/test-reporter@v2
continue-on-error: true

View File

@@ -48,17 +48,28 @@ on:
cobertura_report:
description: 'Cobertura file to upload as an artifact.'
required: false
default: '{"fullpath": "report/typing/cobertura.xml", "directory": "report/typing", "filename": "cobertura.xml"}'
default: >-
{ "fullpath": "report/typing/cobertura.xml",
"directory": "report/typing",
"filename": "cobertura.xml"
}
type: string
junit_report:
description: 'JUnit file to upload as an artifact.'
required: false
default: '{"fullpath": "report/typing/StaticTypingSummary.xml", "directory": "report/typing", "filename": "StaticTypingSummary.xml"}'
default: >-
{ "fullpath": "report/typing/StaticTypingSummary.xml",
"directory": "report/typing",
"filename": "StaticTypingSummary.xml"
}
type: string
html_report:
description: 'Directory to upload as an artifact.'
required: false
default: '{"fullpath": "report/typing/html", "directory": "report/typing/html"}'
default: >-
{ "directory": "report/typing/html"
}
# "fullpath": "report/typing/html",
type: string
cobertura_artifact:
description: 'Name of the typing cobertura artifact (Cobertura XML).'

View File

@@ -95,44 +95,44 @@ on:
default: 'unit'
type: string
unittest_report_xml:
description: 'Path where to save the unittest summary report XML.'
description: 'JSON object describing the path where to save the unittest summary report XML.'
required: false
default: 'report/unit'
default: >-
{ "directory": "report/unit",
"filename": "TestReportSummary.xml",
"fullpath": "report/unit/TestReportSummary.xml"
}
type: string
# unittest_report_xml_filename:
# description: 'Filename of the unittest summary report XML.'
# required: false
# default: 'TestReportSummary.xml'
# type: string
coverage_config:
description: 'Path to the .coveragerc file. Use pyproject.toml by default.'
required: false
default: 'pyproject.toml'
type: string
coverage_report_xml:
description: 'Directory where the coverage report in XML format will be generated.'
description: 'JSON object describing the path where the coverage report in XML format will be generated.'
required: false
default: 'report/coverage'
default: >-
{ "directory": "report/coverage",
"filename": "coverage.xml",
"fullpath": "report/coverage/coverage.xml"
}
type: string
# coverage_report_xml_filename:
# description: 'Filename how the coverage report in XML format will be named.'
# required: false
# default: 'coverage.xml'
# type: string
coverage_report_json:
description: 'Directory where the coverage report in JSON format will be generated.'
description: 'JSON object describing the path where the coverage report in JSON format will be generated.'
required: false
default: 'report/coverage'
default: >-
{ "directory": "report/coverage",
"filename": "coverage.json",
"fullpath": "report/coverage/coverage.json"
}
type: string
# coverage_report_json_filename:
# description: 'Filename how the coverage report in JSON format will be named.'
# required: false
# default: 'coverage.json'
# type: string
coverage_report_html:
description: 'Directory where the coverage report in HTML format will be generated.'
description: 'JSON object describing the path where the coverage report in HTML format will be generated.'
required: false
default: 'report/coverage/html'
default: >-
{ "directory": "report/coverage/html",
}
# "fullpath": "report/coverage/html"
type: string
unittest_xml_artifact:
description: "Generate unit test report with junitxml and upload results as an artifact."