|
| 1 | +# 5.0.0 - 2026-01-23 |
| 2 | + |
| 3 | +## Summary |
| 4 | + |
| 5 | +In this major release, attention needs to be given to the following: |
| 6 | + |
| 7 | +* `gh-pages.yml` changes |
| 8 | + * See GitHub `upload-pages-artifact` v4 |
| 9 | +* default Poetry version changed from `2.1.2` to `2.3.0` |
| 10 | + * See Poetry Update |
| 11 | + |
| 12 | +### GitHub `upload-pages-artifact` v4 |
| 13 | + |
| 14 | +In v4, the developers of `upload-pages-artifact` dropped support for uploading |
| 15 | +dotfiles. This means that the `gh-pages.yml` has been modified such that it |
| 16 | +converts the generated `.html-documentation` to `html-documentation`. It was also checked |
| 17 | +which files are created by the nox session `docs:build`. It was found that in many cases |
| 18 | +that the only dotfiles produced are `.buildinfo` and `.doctrees`, which do not need |
| 19 | +to be uploaded for the GitHub pages to work. To verify that your project will not be |
| 20 | +adversely affected by these changes, please: |
| 21 | + |
| 22 | +1. Run the nox sessions `docs:build` |
| 23 | +2. Use this command to see what dotfiles are created: |
| 24 | + ```bash |
| 25 | + ls -a .hmtl-documentation/ | grep "^\." |
| 26 | + ``` |
| 27 | +3. If there are other critical dotfiles, consider converting them. Otherwise, create |
| 28 | +an issue in the `python-toolbox`. |
| 29 | + |
| 30 | +### Poetry Update |
| 31 | +The default behavior for `.github/actions/python-environment/action.yml` has changed. |
| 32 | +In previous versions, the default value for `poetry-version` was `2.1.2`, and it is now `2.3.0`. |
| 33 | + |
| 34 | +* For migrating to `2.3.0`, see |
| 35 | +[from Poetry 2.1.x to 2.3.0](https://exasol.github.io/python-toolbox/main/user_guide/dependencies.html#from-poetry-2-1-x-to-2-3-0). |
| 36 | + |
| 37 | +* Depending on its poetry version, a repository relying on the default behavior of said |
| 38 | +action may run into breaking changes. This can easily be resolved with explicitly setting the |
| 39 | +`poetry-version` when calling the GitHub action. It is, however, recommended whenever |
| 40 | +possible to update the poetry version of the affected repository. Since this major release, |
| 41 | +you can, if needed, alter the `poetry-version` via the `noxconfig.py::PROJECT_CONFIG` |
| 42 | +by changing `dependency_manager_version`. If you do this, please create an issue to |
| 43 | +update to `2.3.0` at your earliest convenience. |
| 44 | + |
| 45 | +## Documentation |
| 46 | + |
| 47 | +* #648: Moved sonar setup instructions in the User guide |
| 48 | + |
| 49 | +## Features |
| 50 | + |
| 51 | +* #649: Restricted noxconfig usage throughout exasol.toolbox to only exasol.toolbox.nox.* |
| 52 | +* #647: Added summary to changelog template |
| 53 | +* #657: Updated `release:prepare` to modify cookiecutter template exasol-toolbox version range |
| 54 | +* #665: Added SECURITY.md to the cookiecutter template |
| 55 | +* #667: Switched GitHub workflow templates to be controlled by PROJECT_CONFIG: |
| 56 | + * The values in `BaseConfig.github_template_dict` are used to render the following values in |
| 57 | + the templates |
| 58 | + * `dependency_manager_version` - used for `poetry-version` in the workflows. |
| 59 | + The default it `2.3.0`. |
| 60 | + * `minimum_python_version` - used for `python-version` in the workflows whenever |
| 61 | + `python-version` for actions that are run once. The default is the minimum value |
| 62 | + in your project's defined `python_versions` |
| 63 | + * `os_version` - used for the GitHub runner in the workflows. The default is |
| 64 | + `ubuntu-24.04` |
| 65 | +
|
| 66 | +## Refactoring |
| 67 | +
|
| 68 | +* #624: Updated GitHub python-environment action and all code to use Poetry >= 2.3.0 |
| 69 | +* #662: Update GitHub actions |
| 70 | + * `checkout` from v5 to [v6](https://github.com/actions/checkout/releases/tag/v6.0.0) - using Node.js 24 |
| 71 | + * `upload-pages-artifact` from v3 to [v4](https://github.com/actions/upload-pages-artifact/releases/tag/v4.0.0) - breaking change |
| 72 | + * `download-artifact`from v6 to [v7](https://github.com/actions/download-artifact/releases/tag/v7.0.0) - using Node.js 24 |
| 73 | + * `upload-artifact` from v5 to [v6](https://github.com/actions/upload-artifact/releases/tag/v6.0.0) - using Node.js 24 |
| 74 | +* #667: Added deprecation warnings to `tbx workflow x` endpoints as some are unneeded |
| 75 | +(will be removed) and others need updates (will be moved to a nox session) |
| 76 | +* #669: Updated PTB GitHub workflows |
| 77 | +
|
| 78 | +## Dependency Updates |
| 79 | +
|
| 80 | +### `main` |
| 81 | +* Updated dependency `bandit:1.9.2` to `1.9.3` |
| 82 | +* Updated dependency `black:25.11.0` to `25.12.0` |
| 83 | +* Updated dependency `coverage:7.12.0` to `7.13.1` |
| 84 | +* Updated dependency `furo:2025.9.25` to `2025.12.19` |
| 85 | +* Updated dependency `import-linter:2.7` to `2.9` |
| 86 | +* Updated dependency `mypy:1.19.0` to `1.19.1` |
| 87 | +* Updated dependency `pre-commit:4.5.0` to `4.5.1` |
| 88 | +* Updated dependency `pysonar:1.2.1.3951` to `1.3.0.4086` |
| 89 | +* Updated dependency `pytest:9.0.1` to `9.0.2` |
| 90 | +* Added dependency `pyyaml:6.0.3` |
| 91 | +* Updated dependency `ruff:0.14.8` to `0.14.13` |
| 92 | +* Updated dependency `shibuya:2025.11.10` to `2026.1.9` |
| 93 | +* Updated dependency `sphinx-design:0.6.1` to `0.7.0` |
| 94 | +* Updated dependency `sphinx-toolbox:4.0.0` to `4.1.2` |
| 95 | +* Updated dependency `typer:0.20.0` to `0.21.1` |
| 96 | +
|
| 97 | +### `dev` |
| 98 | +* Added dependency `types-pyyaml:6.0.12.20250915` |
0 commit comments