Skip to content

v10.1.1 - #682

Merged
Paebbels merged 12 commits into
mainfrom
dev
Oct 29, 2026
Merged

Paebbels merged 12 commits into
mainfrom
dev

Conversation

@pytooling-claude

@pytooling-claude pytooling-claude Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Note

A patch release after v10.1.0 (#675).

  • 🪳 The extra dependencies includes ruamel.yaml, which reading a license overrides file needs - documentation builds with pyTooling.Sphinx 1.0 and a Dependency.PackageOverrides.yaml failed without it.
  • 📖 pyTooling's documentation renders its unit test, code coverage and documentation coverage reports as pages of their own.

🪳 Bug Fixes

  • Extra dependencies: it didn't include ruamel.yaml, which pyTooling.Dependency.Python.LicenseOverrides.FromFile() needs to read license overrides from a YAML file (through pyTooling.Configuration.YAML). A project installing only pyTooling[dependencies] failed with MissingDependencyError: Optional dependency 'ruamel.yaml' not installed. when it read such a file - e.g. every documentation build with pyTooling.Sphinx 1.0 whose conf.py sets pyTooling_Dependency_PackageOverrides and whose requirements don't bring ruamel.yaml in another way. The extra now requires ruamel.yaml ~= 0.19, as the extra yaml does. (Extra 'dependencies' includes ruamel.yaml (license overrides file) #684)

📖 Documentation

⚙️ GitHub Pipeline

Others

  • Version 10.1.1.

Related Issues and Pull-Requests

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
@pytooling-claude
pytooling-claude Bot requested a review from Paebbels as a code owner October 27, 2026 23:24
claude-code and others added 6 commits October 28, 2026 19:54
The license override file kept an entry for sphinx-reports, which no
dependency table lists. The commented-out PDFDocumentation job named
'sphinx_reports' as its document; this documentation's LaTeX file is
'pyTooling.tex'.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
…ive only.

The 'PublishToGitHubPages' job got the Coverage.py HTML report as input 'coverage', which it unpacks into
'coverage/' and so overwrote the documentation's 'coverage/index' page rendered by pyTooling.Sphinx. Without the
input, the job skips the download.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
PublishCoverageResults got 'coverage_html_artifact' and 'coverage_report_html',
so it ran 'coverage html' and uploaded the result - only for the
PublishToGitHubPages job, which doesn't publish it anymore. The documentation's
code coverage pages, rendered by pyTooling.Sphinx from coverage.json, replace
it. Without the artifact name, the job skips the conversion and the upload.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
…oc coverage

As pyTooling/Actions#333 and pyTooling.Sphinx do:
* conf.py: 'pages' for the unit test report (unittests/src), the code coverage
  report (coverage/src, with 'sources' for the listings) and the doc coverage
  report (doccoverage/src) - a page per testsuite/testcase, per module and
  file, generated by pyTooling.Sphinx.
* coverage/index.rst is the code coverage page (label CODECOV) with its
  legend; CodeCoverage.rst is removed - it repeated the summary.
* DocCoverage.rst moves to doccoverage/index.rst (label DOCCOV), so its pages
  sit below it as for the other two reports.
* index.rst: the 'References and Reports' toctree lists the three report pages.

A local build with a merged JUnit report (as PublishTestResults writes it) and
coverage.json: 4277 unit test pages, 114 code coverage pages, 72 doc coverage
pages, no error.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
The previous commit holds only the removal of CodeCoverage.rst and the move of
DocCoverage.rst: its 'git add' named the moved files by their old paths, so the
edits it describes weren't staged. They follow here: 'pages' (and 'sources')
in conf.py, coverage/index.rst with the legend, the label DOCCOV and title of
doccoverage/index.rst, and the toctree in index.rst.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
@codacy-production

codacy-production Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@pytooling-claude pytooling-claude Bot added CI: GitHub GitHub Actions / Workflows Documentation Improvements or additions to documentation labels Oct 28, 2026
@codecov

codecov Bot commented Oct 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.20%. Comparing base (3efd47d) to head (9f0e375).
⚠️ Report is 10 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #682   +/-   ##
=======================================
  Coverage   90.20%   90.20%           
=======================================
  Files          66       66           
  Lines       18478    18478           
  Branches     2879     2879           
=======================================
  Hits        16668    16668           
  Misses       1361     1361           
  Partials      449      449           
Flag Coverage Δ
unittests 90.20% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pyTooling.Dependency.Python reads license overrides from a YAML file (LicenseOverrides.FromFile), through
pyTooling.Configuration.YAML, which needs ruamel.yaml. The extra 'dependencies' didn't name it, so a project
installing pyTooling[dependencies] - e.g. pyTooling.Sphinx for its dependency tables - failed with
"Optional dependency 'ruamel.yaml' not installed." when it read its overrides file, unless ruamel.yaml came in
another way. The extra now requires 'ruamel.yaml ~= 0.19', as the extra 'yaml' does; the documentation of
pyTooling.Dependency.Python names it.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
@pytooling-claude pytooling-claude Bot changed the title v10.2.0 v10.1.1 Oct 29, 2026
@pytooling-claude pytooling-claude Bot added bug Something isn't working Dependencies Used by Dependabot. Packaging pyTooling.Packaging labels Oct 29, 2026
The bug fix of the extra 'dependencies' (ruamel.yaml for license overrides files, #684) and the documentation
changes of #683 and #684.

Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
@Paebbels
Paebbels merged commit 311e510 into main Oct 29, 2026
7 of 50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working CI: GitHub GitHub Actions / Workflows Dependencies Used by Dependabot. Documentation Improvements or additions to documentation Packaging pyTooling.Packaging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants