Releases: exasol/python-toolbox
0.18.0
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
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.13.0
0.13.0 - 2024-06-06
🐞 Fixed
- Changed the default linter configuration in the Nox lint task to automatically generate a report. Previously, setting it in pyproject.toml was required.
✨ Feature
- #162: Updated templates for GitHub workflows to inherit secrets by default
- #52: Add support for caching python dependencies in GitHub workflows
📚 Documentation
- Updated information about nox tasks and
PYTHONPATH
setup
🔩 Internal
- Relocked and updated dependencies
0.12.0
0.12.0 - 2024-05-17
🐞 Fixed
- Added missing artifact uploads to checks.yml
✨ Added
-
Added Support for Argument Forwarding to Test-Related Nox Tasks
Overview:
With this new feature, it is now possible to forward additional arguments to the application (pytest) that executes the tests.For example this feature now allows for easy execution of a subset of tests using pytest’s
-k
expression selection or-m
marker selection (see usage examples below).The forwarding will work for the following Nox tasks:
- unit-tests
- integration-tests
- coverage
Usage:
To prepare a release, simply execute a command in your terminal as shown in the examples below:
Filter tests based on pytest markers:
nox -s unit-tests -- -m fast
Filter tests based on pytest expressions:
nox -s unit-tests -- -k smoke_test
0.10.0
0.10.0 - 2024-05-15
🚨 Breaking Changes
Static callbacks/hooks in the Config object have been removed and replaced with Plugin hooks.
For additional information, refer to customization in the user guide.
🐞 Fixed
- Updated templates for GH workflows to add content of changes file for release letter
✨ Added
- Implemented plugin support for
pre-
andpost-
integration-tests hooks.
📚 Documentation
- Added documentation on nox task plugins for users and developers.
- Added documentation on python-environment action.
- Updated theme and structure of the documentation.
🔩 Internal
- Relocked and updated dependencies
0.9.0
0.9.0 - 2024-05-08
🚨 Breaking Changes
-
CI-CD Workflow (Breaking Change)
Overview:
The CI-CD workflow now assumes the changelog to be in markdown and the location
/doc/changes/change_x.y.z.md
🐞 Fixed
- Fixed
_deny_filter
function inexasol.toolbox._shared
module - Fixed GitHub workflow references in
ci.yml
, ci-cd.ymland
pr-merge.yml` workflows - Fixed indent error/issue in
checks.yml
workflow
✨ Added
-
Added Nox Task
prepare-release
Overview:
A new Nox task,
prepare-release
, has been introduced to streamline the release preparation process. This task automates several crucial steps:- Create a dedicated branch for the release changes.
- Transfer changes from the "Unreleased" section to the appropriate versioned changelog section.
- Update the version number to the next release.
- Initiate a Pull Request (PR) for review and integration into the main branch.
Usage:
To prepare a release, simply execute a command in your terminal like in the example below:
nox -s prepare-release -- 1.10.1
Add the changes for releasing on top of the current branch:
nox -s prepare-release -- 1.10.1 --no-pr --no-branch
For additional options and help regarding the task
prepare-release
, execute: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.
- For further details on the plugin specification, refer to
📚 Documentation
- Fixed typos and updated documentation
🔩 Internal
- Restructured
exasol.toolbox.nox
module
0.8.0
0.8.0 - 2024-02-07
✨ Added
- Added output created-issues to security-issues action containing the found security issues including the created GitHub issues in JSONL format.