Skip to content

changes_5.0.0.md

Latest commit

 

History

History
98 lines (80 loc) · 4.63 KB

changes_5.0.0.md

File metadata and controls

98 lines (80 loc) · 4.63 KB

5.0.0 - 2026-01-23

Summary

In this major release, attention needs to be given to the following:

  • gh-pages.yml changes
    • See GitHub upload-pages-artifact v4
  • default Poetry version changed from 2.1.2 to 2.3.0
    • See Poetry Update

GitHub upload-pages-artifact v4

In v4, the developers of upload-pages-artifact dropped support for uploading dotfiles. This means that the gh-pages.yml has been modified such that it converts the generated .html-documentation to html-documentation. It was also checked which files are created by the nox session docs:build. It was found that in many cases that the only dotfiles produced are .buildinfo and .doctrees, which do not need to be uploaded for the GitHub pages to work. To verify that your project will not be adversely affected by these changes, please:

  1. Run the nox sessions docs:build
  2. Use this command to see what dotfiles are created: 
    ls -a .hmtl-documentation/ | grep "^\."
  3. If there are other critical dotfiles, consider converting them. Otherwise, create an issue in the python-toolbox.

Poetry Update

The default behavior for .github/actions/python-environment/action.yml has changed. In previous versions, the default value for poetry-version was 2.1.2, and it is now 2.3.0.

  • For migrating to 2.3.0, see from Poetry 2.1.x to 2.3.0.

  • Depending on its poetry version, a repository relying on the default behavior of said action may run into breaking changes. This can easily be resolved with explicitly setting the poetry-version when calling the GitHub action. It is, however, recommended whenever possible to update the poetry version of the affected repository. Since this major release, you can, if needed, alter the poetry-version via the noxconfig.py::PROJECT_CONFIG by changing dependency_manager_version. If you do this, please create an issue to update to 2.3.0 at your earliest convenience.

Documentation

  • #648: Moved sonar setup instructions in the User guide

Features

  • #649: Restricted noxconfig usage throughout exasol.toolbox to only exasol.toolbox.nox.*
  • #647: Added summary to changelog template
  • #657: Updated release:prepare to modify cookiecutter template exasol-toolbox version range
  • #665: Added SECURITY.md to the cookiecutter template
  • #667: Switched GitHub workflow templates to be controlled by PROJECT_CONFIG:
    • The values in BaseConfig.github_template_dict are used to render the following values in the templates
      • dependency_manager_version - used for poetry-version in the workflows. The default it 2.3.0.
      • minimum_python_version - used for python-version in the workflows whenever python-version for actions that are run once. The default is the minimum value in your project's defined python_versions
      • os_version - used for the GitHub runner in the workflows. The default is ubuntu-24.04

Refactoring

  • #624: Updated GitHub python-environment action and all code to use Poetry >= 2.3.0
  • #662: Update GitHub actions
    • checkout from v5 to v6 - using Node.js 24
    • upload-pages-artifact from v3 to v4 - breaking change
    • download-artifactfrom v6 to v7 - using Node.js 24
    • upload-artifact from v5 to v6 - using Node.js 24
  • #667: Added deprecation warnings to tbx workflow x endpoints as some are unneeded (will be removed) and others need updates (will be moved to a nox session)
  • #669: Updated PTB GitHub workflows

Dependency Updates

main

  • Updated dependency bandit:1.9.2 to 1.9.3
  • Updated dependency black:25.11.0 to 25.12.0
  • Updated dependency coverage:7.12.0 to 7.13.1
  • Updated dependency furo:2025.9.25 to 2025.12.19
  • Updated dependency import-linter:2.7 to 2.9
  • Updated dependency mypy:1.19.0 to 1.19.1
  • Updated dependency pre-commit:4.5.0 to 4.5.1
  • Updated dependency pysonar:1.2.1.3951 to 1.3.0.4086
  • Updated dependency pytest:9.0.1 to 9.0.2
  • Added dependency pyyaml:6.0.3
  • Updated dependency ruff:0.14.8 to 0.14.13
  • Updated dependency shibuya:2025.11.10 to 2026.1.9
  • Updated dependency sphinx-design:0.6.1 to 0.7.0
  • Updated dependency sphinx-toolbox:4.0.0 to 4.1.2
  • Updated dependency typer:0.20.0 to 0.21.1

dev

  • Added dependency types-pyyaml:6.0.12.20250915