Exasol-toolbox

Add the changes for releasing on top of the current branch:

shell
nox -s prepare-release -- 1.10.1 --no-pr --no-branch


For additional options and help regarding the task `prepare-release`, execute:

shell
nox -s prepare-release -- -h


* **Added Plugin Support for Nox Task `prepare-release`**

- For further details on the plugin specification, refer to `exasol.toolbox.nox.plugin`.
- For an example of usage, refer to the `noxconfig` of the Python toolbox.

📚 Documentation
* Fixed typos and updated documentation

🔩 Internal
* Restructured `exasol.toolbox.nox` module

✨ Features

* Added tbx task for markdown formating of .lint.json
* Added a Nox task for dependencies packages and their licenses with Markdown output
* [293](https://github.com/exasol/python-toolbox/issues/293): Added `py.typed` file

🐞 Fixed
* Fixed an issue in the CI workflow that caused it to be executed twice on the initial push of a PR if the PR branch was on the repo itself.

🚨 Attention: Due to these changes, the workflows will no longer be executed if the PR comes from a branch not located in this repository.
As third-party contributions from outside forks are rare to nearly non-existent, this downside was considered a reasonable trade-off at this time.

📚 Documentation
* Updated design doc (Added known Issues)
* Updated migration progress table
* Updated the FAQ with an entry about the ``isort`` compatibility issue
* [351](https://github.com/exasol/python-toolbox/issues/351), [#352](https://github.com/exasol/python-toolbox/issues/352): updated user guide

🔧 Changed
* Updated `actions/upload-artifacts` version to `4.6.0`

🔩 Internal
* Relocked dependencies
* Update referenced github actions

⚒️ Refactorings
* [339](https://github.com/exasol/python-toolbox/issues/339): Secret ALTERNATIVE_GITHUB_TOKEN removed from GitHub workflows

🚨 Breaking Changes
* **Matrices in CI/CD workflows will be generated automatically now**

Make sure you have installed all the latest workflow files, especially the newly added ones:

- `matrix-all.yml`
- `matrix-python.yml`
- `matrix-exasol.yml`


✨ Added
* Added support for dynamically generated workflow matrices.

This feature allows you to easily change the test matrices in one place: `noxconfig.py`.

Note: As usual, there are different ways a user can adjust or change the behavior. In the case of the build matrices, there are three obvious ways:

- Set the appropriate fields in the `noxconfig.py` project configuration (`PROJECT_CONFIG`):
* `python_versions = [ ... ]`
* `exasol_versions = [ ... ]`
- Overwrite the nox tasks:
* `matrix:all`
* `matrix:python`
* `matrix:exasol`
- Overwrite/replace the matrix generation workflows:
* `matrix-all.yml`
* `matrix-python.yml`
* `matrix-exasol.yml`

Among all of the above, the safest way is to set the matrix-related fields in your project config object in `noxconfig.py`.

* Added a nox task to validate the build/test artifacts and use it in the github workflow report


📚 Documentation

* Added new entries to the frequently asked questions regarding `multiversion documentation`


🐞 Fixed

* Fixed `index.rst` documentation template to provide the correct underlining length of the main heading
* Added multi-version extension to Sphinx configuration of the project template
* fixed bug in tbx worflow install error if directory exists [298](https://github.com/exasol/python-toolbox/issues/298) also [#297](https://github.com/exasol/python-toolbox/issues/297)

🔩 Internal
* Relocked dependencies

🔧 Changed

* Add `__version__` member to generated `version.py` for compatibility with other versions schemes
* Excluded pyupgrade from project check due to its destructive nature
* Updated cookiecutter template
- removed obsolete template file `version.html`
* Added nox task for format checking
* Updated GitHub workflow and workflow template of `checks.yml` to include format check

🐞 Fixed

* Fixed whitespace and final newline behavior in `release:prepare` to work well with `trailing whitespace` commit hook
* Fixed syntax error in the `check.yml` template which resulted in an invalid workflow file
* Fixed context forwarding to plugins hooking into `pre` and `post` integration test hooks
- `pre_integration_tests_hook(self, session, config, context)`
- `post_integration_tests_hook(self, session, config, context)`

📚 Documentation

* Fixed various documentation typos
* Added a toolbox migration guide
* Fixed version information in GitHub Actions reference
* Updated the `pre-commit` related documentation

✨ Added

* Added support for Python 3.12 to check.yml build matrices

🔧 Changed

* Updated gh-pages workflow to use the new multiversion nox task target

🐞 Fixed

* Removed the `test` file filter from `lint:security`

🐞 Fixed

* Fixed the issue with publishing new documentation after releasing a new version
* Fixed the issue where master/main was not part of the multiversion documentation

✨ Added

* 149: Added nox task to lint imports
* Added support to manually trigger documentation build
* 248: Added security results to workflow summary
* 233: Added nox task to verify dependency declarations