Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 47 additions & 24 deletions .github/workflows/Pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ on:
- cron: '0 22 * * 5'

jobs:
Prepare:
uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@dev

ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@r4
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
with:
package_name: pyVersioning

UnitTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
with:
name: pyVersioning
# python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
Expand All @@ -24,7 +27,7 @@ jobs:
# disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"

AppTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@r4
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
with:
name: pyVersioning
# python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
Expand Down Expand Up @@ -62,7 +65,7 @@ jobs:
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}

DocCoverage:
uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r4
uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
needs:
- ConfigParams
- UnitTestingParams
Expand Down Expand Up @@ -139,7 +142,7 @@ jobs:
./check.sh ${{ matrix.example }}

PublishCoverageResults:
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r4
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
needs:
- ConfigParams
- UnitTestingParams
Expand All @@ -150,14 +153,12 @@ jobs:
coverage_report_json_filename: ${{ needs.ConfigParams.outputs.coverage_report_json_filename }}
coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
coverage_report_html_directory: ${{ needs.ConfigParams.outputs.coverage_report_html_directory }}
codecov: true
codacy: true
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
CODACY_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
codecov: false
codacy: false
secrets: inherit

PublishTestResults:
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r4
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
needs:
- ConfigParams
- UnitTestingParams
Expand All @@ -169,17 +170,15 @@ jobs:
merged_junit_filename: ${{ needs.ConfigParams.outputs.unittest_merged_report_xml_filename }}
merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
dorny: true
codecov: true
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
codecov: false
secrets: inherit

IntermediateCleanUp:
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r4
needs:
- UnitTestingParams
- PublishCoverageResults
- PublishTestResults
- Documentation
with:
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
Expand Down Expand Up @@ -227,17 +226,42 @@ jobs:
- PublishCoverageResults
- StaticTypeCheck
with:
doc: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
# coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
doc: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}

TriggerTaggedRelease:
uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@dev
needs:
- Prepare
- UnitTesting
- AppTesting
- Examples
# - StaticTypeCheck
- Package
- PublishToGitHubPages
if: needs.Prepare.outputs.is_release_commit
permissions:
contents: write # required for create tag
actions: write # required for trigger workflow
with:
version: ${{ needs.Prepare.outputs.version }}
auto_tag: ${{ needs.Prepare.outputs.is_release_commit }}
secrets: inherit

ReleasePage:
uses: pyTooling/Actions/.github/workflows/Release.yml@r4
if: startsWith(github.ref, 'refs/tags')
uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@dev
if: needs.Prepare.outputs.is_release_tag == 'true'
needs:
- Prepare
- AppTesting
- Examples
# - StaticTypeCheck
- Package
- PublishToGitHubPages
with:
tag: ${{ needs.Prepare.outputs.version }}
secrets: inherit

PublishOnPyPI:
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r4
Expand All @@ -247,10 +271,9 @@ jobs:
- ReleasePage
with:
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
requirements: -r dist/requirements.txt
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
requirements: '-r dist/requirements.txt'
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
secrets: inherit

ArtifactCleanUp:
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r4
Expand Down
4 changes: 2 additions & 2 deletions doc/Dependency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ the mandatory dependencies too.
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `typing-extensions <https://GitHub.com/python/typing_extensions>`__ | ≥4.13 | `PSF-2.0 <https://github.com/python/typing_extensions/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `lxml <https://GitHub.com/lxml/lxml>`__ | ≥5.3 | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
| `lxml <https://GitHub.com/lxml/lxml>`__ | ≥5.4 | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+


Expand Down Expand Up @@ -160,7 +160,7 @@ the mandatory dependencies too.
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx-copybutton <https://GitHub.com/executablebooks/sphinx-copybutton>`__ | ≥0.5 | `MIT <https://GitHub.com/executablebooks/sphinx-copybutton/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥3.1 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥3.2 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_reports <https://github.com/pyTooling/sphinx-reports>`__ | ≥0.9 | `Apache License, 2.0 <https://GitHub.com/pyTooling/sphinx-reports/blob/main/LICENSE.md>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down
9 changes: 5 additions & 4 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
# |version| and |release|, also used in various other places throughout the
# built documents.
project = "pyVersioning"
directoryName = project.replace('.', '/')

projectDirectory = Path(f"../{project.replace('.', '/')}")
packageInformationFile = projectDirectory / "__init__.py"
Expand Down Expand Up @@ -266,22 +267,22 @@
# ==============================================================================
report_unittest_testsuites = {
"src": {
"name": "pyVersioning",
"name": f"{project}",
"xml_report": "../report/unit/unittest.xml",
}
}
report_codecov_packages = {
"src": {
"name": "pyVersioning",
"name": f"{project}",
"json_report": "../report/coverage/coverage.json",
"fail_below": 80,
"levels": "default"
}
}
report_doccov_packages = {
"src": {
"name": "pyVersioning",
"directory": "../pyVersioning",
"name": f"{project}",
"directory": f"../{directoryName}",
"fail_below": 80,
"levels": "default"
}
Expand Down
2 changes: 1 addition & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ sphinxcontrib-mermaid ~= 1.0
autoapi >= 2.0.1
sphinx_design ~= 0.6.1
sphinx-copybutton ~= 0.5.2
sphinx_autodoc_typehints ~= 3.1
sphinx_autodoc_typehints ~= 3.2
sphinx_reports ~= 0.9
2 changes: 1 addition & 1 deletion pyVersioning/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
__email__ = "Paebbels@gmail.com"
__copyright__ = "2020-2025, Patrick Lehmann"
__license__ = "Apache License, Version 2.0"
__version__ = "0.18.0"
__version__ = "0.18.1"
__keywords__ = ["Python3", "Template", "Versioning", "Git"]

from dataclasses import make_dataclass
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[build-system]
requires = [
"setuptools ~= 79.0",
"setuptools >= 80.0",
"wheel ~= 0.45",
"pyTooling ~= 8.4"
]
Expand Down
3 changes: 2 additions & 1 deletion run.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Param(
)

$PackageName = "pyVersioning"
$PackageVersion = "0.18.1"

# set default values
$EnableDebug = [bool]$PSCmdlet.MyInvocation.BoundParameters["Debug"]
Expand Down Expand Up @@ -97,7 +98,7 @@ if ($install)
{ Write-Host -ForegroundColor Cyan "[ADMIN][UNINSTALL] Uninstalling $PackageName ..."
py -3.13 -m pip uninstall -y $PackageName
Write-Host -ForegroundColor Cyan "[ADMIN][INSTALL] Installing $PackageName from wheel ..."
py -3.13 -m pip install .\dist\$PackageName-0.18.0-py3-none-any.whl
py -3.13 -m pip install .\dist\$PackageName-$PackageVersion-py3-none-any.whl

Write-Host -ForegroundColor Cyan "[ADMIN][INSTALL] Closing window in 5 seconds ..."
Start-Sleep -Seconds 5
Expand Down
2 changes: 1 addition & 1 deletion tests/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ pytest-cov ~= 6.1
# Static Type Checking
mypy ~= 1.15
typing_extensions ~= 4.13
lxml ~= 5.3
lxml ~= 5.4
Loading