Merge branch 'main' into feature/#409-Doc-link-&-checks

Author: ArBridgeman

.github/actions/python-environment/action.yml

@@ -1,5 +1,5 @@
 name: 'SPPE'
-description: 'Setup python and poetry environment'
+description: 'Set up python and poetry environment'
 
 inputs:
 
@@ -15,25 +15,47 @@ inputs:
 
   working-directory:
     description: 'Working directory to use'
-    required: true
+    required: false
     default: "."
 
+  extras:
+    description: 'Comma-separated list of extras'
+    required: false
+
+  use-cache:
+    description: 'Use cache for poetry environment'
+    required: false
+    default: 'true'
+
 runs:
 
   using: "composite"
   steps:
 
-    - name: Setup Poetry (${{ inputs.poetry-version }})
+    - name: Set up pipx if not present
+      shell: bash
+      run: |
+        python3 -m pip install --upgrade pipx
+        python3 -m pipx ensurepath
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+    - name: Set up Poetry (${{ inputs.poetry-version }})
       shell: bash
       run: pipx install poetry==${{ inputs.poetry-version }}
 
-    - name: Setup Python (${{ inputs.python-version}})
+    - name: Set up Python (${{ inputs.python-version}})
       uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
-        cache: 'poetry'
+        cache: ${{ inputs.use-cache == 'true' && 'poetry' || '' }}
 
-    - name: Poetry install
+    - name: Poetry install with extras
       working-directory: ${{ inputs.working-directory }}
       shell: bash
-      run: poetry install
+      run: |
+        EXTRAS=$(echo "${{ inputs.extras }}" | tr -d ' ')
+        if [[ -n "$EXTRAS" ]]; then
+          poetry install --extras "$EXTRAS"
+        else
+          poetry install
+        fi

.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.1.0
+        pip install exasol-toolbox==1.2.0
 
     - name: Create Security Issue Report
       shell: bash

.github/workflows/checks.yml

@@ -20,7 +20,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Check Version(s)
-        run: poetry run -- nox -s version:check -- `poetry run -- python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
+        run: poetry run -- nox -s version:check
 
   Documentation:
     name: Docs

.github/workflows/gh-pages.yml

@@ -22,6 +22,7 @@ jobs:
       - name: Build Documentation
         run: |
           poetry run -- nox -s docs:multiversion
+          rm -r .html-documentation/*/.doctrees
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

doc/changes/changelog.md

@@ -1,6 +1,7 @@
 # Changelog
 
 * [unreleased](unreleased.md)
+* [1.2.0](changes_1.2.0.md)
 * [1.1.0](changes_1.1.0.md)
 * [1.0.1](changes_1.0.1.md)
 * [1.0.0](changes_1.0.0.md)
@@ -33,6 +34,7 @@
 hidden:
 ---
 unreleased
+changes_1.2.0
 changes_1.1.0
 changes_1.0.1
 changes_1.0.0

doc/changes/changes_1.2.0.md

@@ -0,0 +1,40 @@
+# 1.2.0 - 2025-05-20
+
+## Summary
+
+With #420, any GitHub repos using the PTB for **documentation** will also need to
+reconfigure the GitHub Pages settings for each repo:
+1. Go to the affected repo's GitHub page
+2. Select 'Settings'
+3. Scroll down & select 'Pages'
+4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
+
+This should also create a 'github-pages' environment, if it does not yet exist.
+For most repos using the PTB, the updating of the github pages only happens when a
+PR is merged to main, so please check post-merge that it worked as expected.
+
+With #422, we have hardened the security in our GitHub workflows by explicitly
+setting permissions to the default GitHub token. In a few repos who greatly differ
+from the default PTB setup, this might lead to small issues which require the allowed
+permissions to be increased for specific jobs.
+
+## ⚒️ Refactorings
+
+* [#412](https://github.com/exasol/python-toolbox/issues/392):  Refactored pre commit hook package version.py into nox task
+
+## Security
+
+* [#420](https://github.com/exasol/python-toolbox/issues/420): Replaced 3rd party action with GitHub actions for gh-pages
+* [#422](https://github.com/exasol/python-toolbox/issues/422): Set permissions within the GitHub workflows to restrict usage of the default GitHub token
+
+## ✨ Features
+
+* [#161](https://github.com/exasol/python-toolbox/issues/161): Added support for installing extras & not using a cache to the python-environment action
+* [#408](https://github.com/exasol/python-toolbox/issues/408): Added support for GitHub runners who do not per default have pipx to use the python-environment action
+* [#433](https://github.com/exasol/python-toolbox/issues/433): Removed directory .html-documentation/.doctrees after creating documentation
+* [#436](https://github.com/exasol/python-toolbox/issues/436): Updated template for new projects to poetry 2.x
+
+## Bugfixes
+
+* [#428](https://github.com/exasol/python-toolbox/issues/428): Fixed detecting report coverage failures
+* [#434](https://github.com/exasol/python-toolbox/issues/434): Adapted template so new projects do not fail from lint errors

doc/changes/unreleased.md

@@ -2,27 +2,12 @@
 
 ## Summary
 
-With #420, any GitHub repos using the PTB for **documentation** will also need to 
-reconfigure the GitHub Pages settings for each repo:
-1. Go to the affected repo's GitHub page
-2. Select 'Settings'
-3. Scroll down & select 'Pages'
-4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
+With #441, please ensure that the location of the `version.py` is given for `Config.version_file`,
+which is specified in the `noxconfig.py`
 
-This should also create a 'github-pages' environment, if it does not yet exist.
-For most repos using the PTB, the updating of the github pages only happens when a
-PR is merged to main, so please check post-merge that it worked as expected.
+## 📚 Documentation
+* Updated getting_started.rst for allowing tag-based releases
 
-With #422, we have hardened the security in our GitHub workflows by explicitly
-setting permissions to the default GitHub token. In a few repos who greatly differ
-from the default PTB setup, this might lead to small issues which require the allowed
-permissions to be increased for specific jobs.
+## ✨ Features
 
-## ⚒️ Refactorings
-
-* [#412](https://github.com/exasol/python-toolbox/issues/392):  Refactored pre commit hook package version.py into nox task
-
-## Security
-
-* [#420](https://github.com/exasol/python-toolbox/issues/420): Replaced 3rd party action with GitHub actions for gh-pages
-* [#422](https://github.com/exasol/python-toolbox/issues/422): Set permissions within the GitHub workflows to restrict usage of the default GitHub token
+* [#441](https://github.com/exasol/python-toolbox/issues/441): Switched nox task for `version:check` to use the config value of `version_file` to specify the location of the `version.py`

doc/github_actions/python_environment.rst

@@ -19,6 +19,18 @@ Parameters
      - Poetry version to use
      - True
      - 2.1.2
+   * - working-directory
+     - Working directory to use
+     - False
+     - .
+   * - extras
+     - Comma-separated list of extras
+     - False
+     - (not used by default)
+   * - use-cache
+     - Use cache for poetry environment
+     - False
+     - true
 
 Example Usage
 -------------
@@ -40,9 +52,12 @@ Example Usage
             uses: actions/checkout@v4
 
           - name: Setup Python & Poetry Environment
-            uses: exasol/python-toolbox/.github/actions/python-environment@0.21.0
+            uses: exasol/python-toolbox/.github/actions/python-environment@1.1.0
             with:
               python-version: 3.12
               poetry-version: 2.1.2
+              working-directory: pytest-backend
+              use-cache: false
+              extras: 'numpy,pandas'
 
             ...

doc/user_guide/getting_started.rst

@@ -186,11 +186,22 @@ forward, and you just can use the example *noxfile.py* below.
 Within the `gh-pages.yml`, we use the GitHub `upload-pages-artifact` and `deploy-pages`
 actions. In order to properly deploy your pages, you'll need to reconfigure the GitHub
 Pages settings for the repo:
+
 1. Go to the affected repo's GitHub page
 2. Select 'Settings'
 3. Scroll down & select 'Pages'
 4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
 
+We also need to configure settings for github-pages environment:
+
+1. Go to the affected repo's GitHub page
+2. Select 'Settings'
+3. Scroll down & select 'Environment'
+4. Click on 'github-pages'
+5. In the 'Deployment branches and tags', click 'Add deployment branch or tag rule'
+6. Select 'Ref type' to be 'Tag' and set the 'Name pattern' to `[0-9]*.[0-9]*.[0-9]*` (or whatever matches that repo's tags)
+
+
 8. Go 🥜
 +++++++++++++
 You are ready to use the toolbox. With *nox -l* you can list all available tasks.

exasol/toolbox/metrics.py

@@ -112,16 +112,20 @@ def total_coverage(file: Union[str, Path]) -> float:
             encoding="utf-8",
         )
         stdout = p.stdout.strip()
-        if (p.returncode == 1) and (stdout == "No data to report."):
-            print(
+
+        if p.returncode != 0:
+            message = (
                 f"The following command"
                 f" returned non-zero exit status {p.returncode}:\n"
                 f'  {" ".join(p.args)}\n'
-                f"{stdout}\n"
-                "Returning total coverage 100 %.",
-                file=sys.stderr,
+                f"{stdout}"
             )
-            return 100.0
+            if (p.returncode == 1) and (stdout == "No data to report."):
+                print(f"{message}\nReturning total coverage 100 %.", file=sys.stderr)
+                return 100.0
+            else:
+                raise RuntimeError(message)
+
         with open(report, encoding="utf-8") as r:
             data = json.load(r)
             total: float = data["totals"]["percent_covered"]