Release/prepare 6.0.0

.github/actions/security-issues/action.yml

@@ -39,7 +39,7 @@ runs:
     - name: Install Python Toolbox / Security tool
       shell: bash
       run: |
-        pip install exasol-toolbox==5.1.1
+        pip install exasol-toolbox==6.0.0
 
     - name: Create Security Issue Report
       shell: bash

doc/changes/changes_6.0.0.md

@@ -0,0 +1,40 @@
+# 6.0.0 - 2026-02-26
+
+## Summary
+
+In this major version:
+* the Nox session `workflow:generate` has been added to replace the deprecated
+`tbx workflow install` and `tbx workflow update`. It has the additional feature
+that users may customize the PTB provided workflows with a `.workflow-patcher.yml`
+file, as detailed in [Customize Workflows for Your Project](https://exasol.github.io/python-toolbox/main/user_guide/features/github_workflows/create_and_update.html#customize-workflows-for-your-project).
+* the GitHub workflow templates have been modified to include step_ids and to follow
+an AP-format naming convention, as such it is anticipated that updating the workflows
+results in several small changes.
+
+## Feature
+
+* #691: Started customization of PTB workflows by defining the YML schema
+* #712: Added basic logging to workflow processing
+* #714: Added logic to modify a workflow using the` .workflow-patcher.yml`
+* #717: Restricted workflow names in `.workflow-patcher.yml` to template workflow names
+* #719: Added Nox session `workflow:generate` to generate/update workflows using the `.workflow-patcher.yml` (if desired)
+* #725: Added newline after headlines for dependency changes
+
+## Documentation
+
+* #705: Described how the versions of poetry and python are retrieved
+* #706: Added description how to ignore findings to the User Guide
+* #721: Added documentation for Nox session `workflow:generate`
+
+## Refactoring
+
+* #664: Removed deprecation warning for projects to switch over to BaseConfig
+* #637: Added id to workflow templates  & synchronized on naming conventions
+* #702: Fixed StepCustomization.content to list[StepContent] and security concern for `update_cookiecutter_default`
+* #710: Refactored and added custom exceptions to YamlRender-based classes
+
+## Dependency Updates
+
+### `main`
+
+* Added dependency `structlog:25.5.0`

doc/changes/unreleased.md

@@ -1,34 +1,3 @@
 # Unreleased
 
 ## Summary
-
-In this major version:
-* the Nox session `workflow:generate` has been added to replace the deprecated
-`tbx workflow install` and `tbx workflow update`. It has the additional feature
-that users may customize the PTB provided workflows with a `.workflow-patcher.yml`
-file.
-* the GitHub workflow templates have been modified to include step_ids and to follow
-an AP-format naming convention, as such it is anticipated that updating the workflows
-results in several small changes.
-
-## Feature
-
-* #691: Started customization of PTB workflows by defining the YML schema
-* #712: Added basic logging to workflow processing
-* #714: Added logic to modify a workflow using the` .workflow-patcher.yml`
-* #717: Restricted workflow names in `.workflow-patcher.yml` to template workflow names
-* #719: Added Nox session `workflow:generate` to generate/update workflows using the `.workflow-patcher.yml` (if desired)
-* #725: Added newline after headlines for dependency changes
-
-## Documentation
-
-* #705: Described how the versions of poetry and python are retrieved
-* #706: Added description how to ignore findings to the User Guide
-* #721: Added documentation for Nox session `workflow:generate`
-
-## Refactoring
-
-* #664: Removed deprecation warning for projects to switch over to BaseConfig
-* #637: Added id to workflow templates  & synchronized on naming conventions
-* #702: Fixed StepCustomization.content to list[StepContent] and security concern for `update_cookiecutter_default`
-* #710: Refactored and added custom exceptions to YamlRender-based classes

doc/user_guide/features/github_workflows/create_and_update.rst

@@ -21,7 +21,7 @@ Poetry Version
 PTB has a default value for the Poetry version but you can override it in file
 ``noxconfig.py``, e.g.
 
-.. code-block:: shell
+.. code-block:: python
 
     PROJECT_CONFIG = Config(
         dependency_manager=DependencyManager(name="poetry", version="2.3.0"),
@@ -39,7 +39,7 @@ free of bugs and working correctly for each combination of these items.
 The PTB has a default for these versions, but you can override it in the
 ``noxconfig.py`` file, e.g.
 
-.. code-block:: shell
+.. code-block:: python
 
     PROJECT_CONFIG = Config(
         python_versions=("3.10", "3.12),

exasol/toolbox/templates/github/workflows/build-and-publish.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/check-release-tag.yml

@@ -17,7 +17,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/checks.yml

@@ -16,7 +16,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"
@@ -37,7 +37,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"
@@ -63,7 +63,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"
@@ -88,7 +88,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: ${{ matrix.python-versions }}
           poetry-version: "(( dependency_manager_version ))"
@@ -124,7 +124,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: ${{ matrix.python-versions }}
           poetry-version: "(( dependency_manager_version ))"
@@ -150,7 +150,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: ${{ matrix.python-versions }}
           poetry-version: "(( dependency_manager_version ))"
@@ -179,7 +179,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"
@@ -201,7 +201,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"
@@ -227,7 +227,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: ${{ matrix.python-versions }}
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/gh-pages.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/matrix-all.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/matrix-exasol.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/matrix-python.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/report.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: "(( minimum_python_version ))"
           poetry-version: "(( dependency_manager_version ))"

exasol/toolbox/templates/github/workflows/slow-checks.yml

@@ -29,7 +29,7 @@ jobs:
 
       - name: Set up Python & Poetry Environment
         id: set-up-python-and-poetry-environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@v5
+        uses: exasol/python-toolbox/.github/actions/python-environment@v6
         with:
           python-version: ${{ matrix.python-version }}
           poetry-version: "(( dependency_manager_version ))"

project-template/cookiecutter.json

@@ -9,7 +9,7 @@
   "author_email": "opensource@exasol.com",
   "project_short_tag": "",
   "python_version_min": "3.10",
-  "exasol_toolbox_version_range": ">=5.1.1,<6",
+  "exasol_toolbox_version_range": ">=6.0.0,<7",
   "license_year": "{% now 'utc', '%Y' %}",
   "__repo_name_slug": "{{cookiecutter.package_name}}",
   "__package_name_slug": "{{cookiecutter.package_name}}",

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "exasol-toolbox"
-version = "5.1.1"
+version = "6.0.0"
 description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project."
 authors = [
     { name = "Nicola Coretti", email = "nicola.coretti@exasol.com" },