Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/actions/python-environment/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ runs:
key: poetry-env-${{ steps.setup-cache-variables.outputs.POETRY_SHA }}-${{ steps.setup-cache-variables.outputs.IMAGE_OS }}-${{ steps.setup-cache-variables.outputs.IMAGE_VERSION }}-${{ runner.arch }}-${{ inputs.poetry-version }}-${{ inputs.python-version }}-${{ inputs.extras }}

- name: Poetry install with extras
if: inputs.use-cache != 'true' || steps.cache-poetry-env.outputs.cache-hit != 'true'
working-directory: ${{ inputs.working-directory }}
shell: bash
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/security-issues/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ runs:
- name: Install Python Toolbox / Security tool
shell: bash
run: |
pip install exasol-toolbox==1.9.0
pip install exasol-toolbox==1.10.0

- name: Create Security Issue Report
shell: bash
Expand Down
2 changes: 2 additions & 0 deletions doc/changes/changelog.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

45 changes: 45 additions & 0 deletions doc/changes/changes_1.10.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# 1.10.0 - 2025-10-10
New `BasConfig` class and improved Setup Python Github Action.

## BaseConfig class for PTB attributes

The BaseConfig class was introduced in this version. This class is used to consolidate
the attributes needed for the PTB's functionalities into an inherited object which can
be expanded upon as needed. At this point, the BaseConfig class includes
``python_versions``, ``exasol_versions``, and ``create_major_version_tags``. Users of
the PTB should update their ``noxconfig.py`` to start using this feature.

```python
# noxconfig.py
from exasol.toolbox.config import BaseConfig


# existing Config should inherit from BaseConfig
class Config(BaseConfig):
# if present, remove any attributes already in the BaseConfig from the added attributes
...


# if no overlapping attributes with `BaseConfig` were present in `Config`, then this is unmodified.
PROJECT_CONFIG = Config()
# if no overlapping attributes with `BaseConfig` were present in `Config`, then this should be modified.
PROJECT_CONFIG = Config(python_versions=(...), exasol_versions=(...), create_major_version_tags=True)
```

## Feature

* #465: Created BaseConfig class to better synchronize attributes needed for the PTB's
growing functionalities

## Internal:

* Call poetry install always in setup python actions

## Dependency Updates

### `main`
* Updated dependency `coverage:7.10.3` to `7.10.6`
* Updated dependency `import-linter:2.3` to `2.4`
* Updated dependency `shibuya:2025.7.24` to `2025.8.16`
* Added dependency `sphinx-toolbox:4.0.0`
* Updated dependency `typer:0.16.0` to `0.17.3`
30 changes: 0 additions & 30 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1,31 +1 @@
# Unreleased

## BaseConfig class for PTB attributes

The BaseConfig class was introduced in this version. This class is used to consolidate
the attributes needed for the PTB's functionalities into an inherited object which can
be expanded upon as needed. At this point, the BaseConfig class includes
``python_versions``, ``exasol_versions``, and ``create_major_version_tags``. Users of
the PTB should update their ``noxconfig.py`` to start using this feature.

```python
# noxconfig.py
from exasol.toolbox.config import BaseConfig


# existing Config should inherit from BaseConfig
class Config(BaseConfig):
# if present, remove any attributes already in the BaseConfig from the added attributes
...


# if no overlapping attributes with `BaseConfig` were present in `Config`, then this is unmodified.
PROJECT_CONFIG = Config()
# if no overlapping attributes with `BaseConfig` were present in `Config`, then this should be modified.
PROJECT_CONFIG = Config(python_versions=(...), exasol_versions=(...), create_major_version_tags=True)
```

## Feature

* #465: Created BaseConfig class to better synchronize attributes needed for the PTB's
growing functionalities
2 changes: 1 addition & 1 deletion doc/user_guide/features/metrics/collecting_metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ into a report:

#. SonarQube analysis
This summarization tool feeds into a feature-rich UI provided by
`Sonar <https://docs.sonarsource.com/sonarqube-server/latest/>`__. For further
`Sonar <https://docs.sonarsource.com/sonarqube-server>`__. For further
details, see :ref:`sonarqube_analysis`

Both of these reporting options require that the generated files from the :ref:`generated_metrics`
Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide/features/metrics/sonar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SonarQube analysis
==================

The PTB supports using `SonarQube Cloud <https://docs.sonarsource.com/sonarqube-server/latest/>`__
The PTB supports using `SonarQube Cloud <https://docs.sonarsource.com/sonarqube-server>`__
to analyze, visualize, & track linting, security, & coverage. All of our Python projects
should be evaluated against the `Exasol Way`_ and subscribe to the
`Clean as You Code <https://docs.sonarsource.com/sonarqube-server/9.8/user-guide/clean-as-you-code/>`__
Expand Down
2 changes: 1 addition & 1 deletion exasol/toolbox/version.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "exasol-toolbox"
version = "1.9.0"
version = "1.10.0"
requires-python = ">=3.9,<4.0"
description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project."
authors = [
Expand Down