5.0.0 - 2026-01-23¶
Summary¶
In this major release, attention needs to be given to the following:
gh-pages.ymlchangesSee GitHub
upload-pages-artifactv4
default Poetry version changed from
2.1.2to2.3.0See 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:
Run the nox sessions
docs:buildUse this command to see what dotfiles are created:
ls -a .hmtl-documentation/ | grep "^\."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-versionwhen 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 thepoetry-versionvia thenoxconfig.py::PROJECT_CONFIGby changingdependency_manager_version. If you do this, please create an issue to update to2.3.0at 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:prepareto 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_dictare used to render the following values in the templatesdependency_manager_version- used forpoetry-versionin the workflows. The default it2.3.0.minimum_python_version- used forpython-versionin the workflows wheneverpython-versionfor actions that are run once. The default is the minimum value in your project’s definedpython_versionsos_version- used for the GitHub runner in the workflows. The default isubuntu-24.04
Refactoring¶
#624: Updated GitHub python-environment action and all code to use Poetry >= 2.3.0
#662: Update GitHub actions
#667: Added deprecation warnings to
tbx workflow xendpoints 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.2to1.9.3Updated dependency
black:25.11.0to25.12.0Updated dependency
coverage:7.12.0to7.13.1Updated dependency
furo:2025.9.25to2025.12.19Updated dependency
import-linter:2.7to2.9Updated dependency
mypy:1.19.0to1.19.1Updated dependency
pre-commit:4.5.0to4.5.1Updated dependency
pysonar:1.2.1.3951to1.3.0.4086Updated dependency
pytest:9.0.1to9.0.2Added dependency
pyyaml:6.0.3Updated dependency
ruff:0.14.8to0.14.13Updated dependency
shibuya:2025.11.10to2026.1.9Updated dependency
sphinx-design:0.6.1to0.7.0Updated dependency
sphinx-toolbox:4.0.0to4.1.2Updated dependency
typer:0.20.0to0.21.1
dev¶
Added dependency
types-pyyaml:6.0.12.20250915