Release/prepare 1.6.1 (#496)

* Update documentation with exclusion & add summary to unreleased

* Prepare version 1.6.1.

* Update doc/changes/changes_1.6.1.md

Co-authored-by: Thomas Ubensee <[email protected]>

---------

Co-authored-by: Thomas Ubensee <[email protected]>

Author: ArBridgeman

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

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

doc/changes/changelog.md

@@ -1,6 +1,7 @@
 # Changelog
 
 * [unreleased](unreleased.md)
+* [1.6.1](changes_1.6.1.md)
 * [1.6.0](changes_1.6.0.md)
 * [1.5.0](changes_1.5.0.md)
 * [1.4.0](changes_1.4.0.md)
@@ -38,6 +39,7 @@
 hidden:
 ---
 unreleased
+changes_1.6.1
 changes_1.6.0
 changes_1.5.0
 changes_1.4.0

doc/changes/changes_1.6.1.md

@@ -0,0 +1,28 @@
+# 1.6.1 - 2025-07-16
+
+## Summary
+
+This version of the PTB resolves many bugs associated with the cookiecutter template
+and creating a new project that uses the PTB.
+
+If any directories or files specified in your `noxconfig.py` via `Config.source` should
+not be included in a Sonar analysis, it is recommended to add the following to
+your `pyproject.toml` under the `[tool.sonar]` section:
+
+```toml
+exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
+```
+
+## Bugfixes
+
+* #489: Fixed .pre-commit-config.yaml to use existing nox tasks
+* #490: Fixed artifacts:validate & sonar:check to work for newly created projects
+* #484: Fixed hint command text in version.py to include -s for executing nox task
+
+## Documentation
+
+* #488: Updated user guide to make clearer under which conditions branch protections based on GitHub actions can be enacted
+
+## Refactoring
+
+* #482: Updated pull_request_template.md to reflect checks we should regularly perform

doc/changes/unreleased.md

@@ -1,15 +1 @@
 # Unreleased
-
-## Bugfixes
-
-* #489: Fixed .pre-commit-config.yaml to use existing nox tasks
-* #490: Fixed artifacts:validate & sonar:check to work for newly created projects
-* #484: Fixed hint command text in version.py to include -s for executing nox task
-
-## Documentation
-
-* #488: Updated user guide to make clearer under which conditions branch protections based on GitHub actions can be enacted
-
-## Refactoring
-
-* #482: Updated pull_request_template.md to reflect checks we should regularly perform

doc/user_guide/getting_started.rst

@@ -229,6 +229,7 @@ For a **public** project
         projectKey = "com.exasol:<project-key>"
         hostUrl = "https://sonarcloud.io"
         organization = "exasol"
+        exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
 6. Post-merge, update the branch protections to include SonarQube analysis
 
   * This should only be done when tests exist for the project, & that the project is
@@ -253,8 +254,15 @@ For a **private** project
         projectKey = "com.exasol:<project-key>"
         hostUrl = "https://sonar.exasol.com"
         organization = "exasol"
+        exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
 6. Post-merge, update the branch protections to include SonarQube analysis from exasonarqubeprchecks
 
+  * This should only be done when tests exist for the project, & that the project is
+    at a state in which enforced code coverage would not be a burden. For new projects,
+    we recommend creating an issue to add the SonarQube analysis to the branch protections
+    at a later point. In such scenarios, SonarQube analysis will still report its analysis
+    results to the PR, but it will not prevent the PR from being merged.
+
 9. Go 🥜
 +++++++++++++
 You are ready to use the toolbox. With *nox -l* you can list all available tasks.

exasol/toolbox/nox/_package_version.py

@@ -20,14 +20,15 @@
 
 # fmt: off
 _VERSION_MODULE_TEMPLATE = cleandoc('''
-    """ ATTENTION:
+    """ATTENTION:
     This file is generated by exasol/toolbox/nox/_package_version.py when using:
        * either "poetry run -- nox -s project:fix"
        * or "poetry run -- nox -s version:check -- --fix"
     Do not edit this file manually!
     If you need to change the version, do so in the pyproject.toml, e.g. by using
     `poetry version X.Y.Z`.
     """
+
     MAJOR = {major}
     MINOR = {minor}
     PATCH = {patch}

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

@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Build Artifacts
         run: poetry build

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

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Check Tag Version
         # make sure the pushed/created tag matched the project version

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

@@ -16,7 +16,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Check Version(s)
         run: poetry run -- nox -s version:check
@@ -32,7 +32,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Build Documentation
         run: |
@@ -59,7 +59,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Run changelog update check
         run: poetry run -- nox -s changelog:updated
@@ -78,7 +78,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -109,7 +109,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -131,7 +131,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -155,7 +155,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Run format check
         run: poetry run -- nox -s project:format
@@ -177,7 +177,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 

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

@@ -17,7 +17,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected].0
+        uses: exasol/python-toolbox/.github/actions/[email protected].1
 
       - name: Build Documentation
         run: |