1.0.1

1.0.1 - 2025-04-11

Bugfixes

• #397: Fixed handling empty coverage
• #403: Removed unneeded poetry run from internal code of nox tasks

Refactorings

• #399: Modified release:prepare to update .github/actions with new PTB version

1.0.0

1.0.0 - 2025-04-04

Summary

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

• 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 affected repository to 2.x.

✨ Features

• #73: Added nox target for auditing work spaces in regard to known vulnerabilities
• #65: Added a Nox task for checking if the changelog got updated.
• #369: Removed option -v for isort
• #372: Added conversion from pip-audit JSON to expected GitHub Issue format

⚒️ Refactorings

• #388: Switched GitHub workflows to use pinned OS version
• #376: Updated to poetry 2.1.2

0.21.0

0.21.0 - 2025-02-25

✨ Features

• Added tbx task for markdown formating of .lint.json
• Added a Nox task for dependencies packages and their licenses with Markdown output
• #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, #352: updated user guide

🔧 Changed

• Updated actions/upload-artifacts version to 4.6.0

🔩 Internal

• Relocked dependencies
• Update referenced github actions

⚒️ Refactorings

• #339: Secret ALTERNATIVE_GITHUB_TOKEN removed from GitHub workflows

0.20.0

0.20.0 - 2024-12-17

🚨 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 also #297

🔩 Internal

• Relocked dependencies

0.19.0

0.19.0 - 2024-12-05

🔧 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

0.18.0

0.18.0 - 2024-11-19

✨ 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

0.17.0

0.17.0 - 2024-11-18

🐞 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

0.16.0

0.16.0 - 2024-11-15

🚨 Breaking Changes

• Dropped python 3.8 support

• Changed names of all nox tasks

  Old Name	New Name	Description
  fix	project:fix	Runs all automated fixes on the code base
  check	project:check	Runs all available checks on the project
  report	project:report	Collects and generates metrics summary for the workspace
  unit-tests	test:unit	Runs all unit tests
  integration-tests	test:integration	Runs all the integration tests
  coverage	test:coverage	Runs all tests (unit + integration) and reports the code coverage
  lint	lint:code	Runs the static code analyzer on the project
  type-check	lint:typing	Runs the type checker on the project
  security	lint:security	Runs the security linter on the project
  build-build	docs:build	Builds the project documentation
  open-open	docs:open	Opens the built project documentation
  clean-docs	docs:clean	Removes the documentations build folder
  prepare-release	release:prepare	Prepares the project for a new release

✨ Added

• Added support for multi version Documentation
• Added nox tasks for building multi-version documentation

🐞 Fixed

• Fixed CD workflow template
• Fixed the selection of the latest version in Multi-Version Documentation

📚 Documentation

• Added Documentation on Metrics
• Added additional details regarding adjusted sphinx-multiversion
• Restructured documentation

🔩 Internal

• Relocked dependencies

0.15.0

0.15.0 - 2024-09-27

✨ Added

• Added cookiecutter-template for creating new project
• #246: Added standard branch protection workflow

🐞 Bug Fixes

• #181: Updated metrics related workflows
• #225: Fixed broken reference to version file in workflow
• Fixed coverage for empty project

⚒️ Refactorings

• #219: Updated project template configuration
• Updated actions/checkout to v4

📚 Documentation

• Add Python Styleguide
• Add Issue Guide
• Updated User Documentation

🔩 Internal

• Update depdency constraints
• Relock dependencies

0.14.0

0.14.0 - 2024-07-02

Doc

• #204: Added a guideline for removing ci-job from workflow pr-merge.yml

Internal

• Relock dependencies