Fix project-template tests to run against unreleased PTB code (#534)

* Fix project-template tests to run against unreleased PTB code

* Update documentation, as we'd expect work on a tag to be complete whereas main might be in an unreleased state

* Alter slow-checks to get manual approval first & separately from tests

* Apply comments per review via IDE to make clearer why certain actions are taken

* Re-add line to checks.yml for fetch-depth

* Fix accidentally switch to 1.7.4 instead of local github usage

* Amend unreleased.md to reflect final state of change

Author: ArBridgeman

.github/workflows/checks.yml

@@ -4,7 +4,6 @@ on:
   workflow_call:
 
 jobs:
-
   Version-Check:
     name: Version
     runs-on: ubuntu-24.04
@@ -43,6 +42,11 @@ jobs:
         run: |
           poetry run -- nox -s links:check
 
+  build-matrix:
+    name: Generate Build Matrix
+    uses: ./.github/workflows/matrix-python.yml
+    permissions:
+      contents: read
 
   Changelog:
     name: Changelog Update Check
@@ -60,12 +64,6 @@ jobs:
       - name: Run changelog update check
         run: poetry run -- nox -s changelog:updated
 
-  build-matrix:
-    name: Generate Build Matrix
-    uses: ./.github/workflows/matrix-python.yml
-    permissions:
-      contents: read
-
   Lint:
     name: Linting (Python-${{ matrix.python-version }})
     needs: [ Version-Check, build-matrix ]
@@ -75,7 +73,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}
-
     steps:
       - name: SCM Checkout
         uses: actions/checkout@v4
@@ -128,6 +125,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}
+
     steps:
       - name: SCM Checkout
         uses: actions/checkout@v4
@@ -175,6 +173,7 @@ jobs:
     steps:
       - name: SCM Checkout
         uses: actions/checkout@v4
+        # The PTB has unit tests which require the fetch-depth to be 0.
         with:
           fetch-depth: 0
 

.github/workflows/ci.yml

@@ -8,14 +8,16 @@ on:
     - cron: "0 0 1/7 * *"
 
 jobs:
+
   CI:
     uses: ./.github/workflows/merge-gate.yml
     secrets: inherit
     permissions:
       contents: read
+
   Metrics:
     needs: [ CI ]
     uses: ./.github/workflows/report.yml
     secrets: inherit
     permissions:
-      contents: read
+      contents: read

.github/workflows/matrix-python.yml

@@ -9,9 +9,9 @@ on:
 
 jobs:
   python_versions:
+    runs-on: ubuntu-24.04
     permissions:
       contents: read
-    runs-on: ubuntu-24.04
     steps:
       - name: SCM Checkout
         uses: actions/checkout@v4

.github/workflows/merge-gate.yml

@@ -11,9 +11,25 @@ jobs:
     permissions:
       contents: read
 
+  run-slow-tests:
+    name: Run Slow Tests
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+
+    # Even though the environment "manual-approval" will be created automatically,
+    # it still needs to be configured to require interactive review.
+    # See project settings on GitHub (Settings / Environments / manual-approval).
+    environment: manual-approval
+    steps:
+      - name: Tests
+        run: echo "Slow tests approved"
+
   slow-checks:
     name: Slow
+    needs: [ run-slow-tests ]
     uses: ./.github/workflows/slow-checks.yml
+    secrets: inherit
     permissions:
       contents: read
 

.github/workflows/pr-merge.yml

@@ -8,6 +8,9 @@ on:
 
 jobs:
 
+  # This job can be removed if certain preconditions are met. See
+  # https://exasol.github.io/python-toolbox/user_guide/workflows.html#pr-merge-workflow
+
   ci-job:
     name: Checks
     uses: ./.github/workflows/checks.yml

.github/workflows/report.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
 
-  Report:
+  report:
     runs-on: ubuntu-24.04
     permissions:
       contents: read
@@ -22,7 +22,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Download Artifacts
-        uses: actions/download-artifact@v4.3.0
+        uses: actions/download-artifact@v4.2.1
         with:
           path: ./artifacts
 
@@ -32,14 +32,14 @@ jobs:
       - name: Validate Artifacts
         run: poetry run -- nox -s artifacts:validate
 
-      - name: Generate Report
-        run: poetry run -- nox -s project:report -- --format json | tee metrics.json
-
       - name: Upload to sonar
         env:
           SONAR_TOKEN: "${{ secrets.SONAR_TOKEN }}"
         run: poetry run -- nox -s sonar:check
 
+      - name: Generate Report
+        run: poetry run -- nox -s project:report -- --format json | tee metrics.json
+
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4.6.2
         with:

.github/workflows/slow-checks.yml

@@ -4,23 +4,18 @@ on:
   workflow_call:
 
 jobs:
-
   build-matrix:
     name: Generate Build Matrix
     uses: ./.github/workflows/matrix-all.yml
     permissions:
       contents: read
 
-  Tests:
+  tests:
     name: Integration-Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
     needs: [ build-matrix ]
     runs-on: ubuntu-24.04
     permissions:
       contents: read
-    # Even though the environment "manual-approval" will be created automatically,
-    # it still needs to be configured to require interactive review.
-    # See project settings on GitHub (Settings / Environments / manual-approval).
-    environment: manual-approval
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     strategy:
@@ -47,7 +42,7 @@ jobs:
           include-hidden-files: true
 
 
-  Verify-Poetry-Installation:
+  verify-poetry-installation:
     # This Job verifies if pipx installation is successful on each of the
     # selected GitHub Runners.
     strategy:
@@ -85,4 +80,4 @@ jobs:
           poetry run which python
           poetry run python --version
           poetry env list
-          poetry run python --version | grep "${{ matrix.python-version }}"
+          poetry run python --version | grep "${{ matrix.python-version }}"

doc/changes/unreleased.md

@@ -4,6 +4,14 @@ With the refactoring of the `dependency:audit`, we use `poetry export`. For how
 be added (project-specific or globally), see the
 [poetry export documentation](https://github.com/python-poetry/poetry-plugin-export).
 
+## Feature
+
+* #469: Moved manual approval for slow tests to merge-gate.yml
+
 ## Refactoring
 
 * #517: Refactored `dependency:audit` & split up to support upcoming work
+
+## Bugfix
+
+* #533: Fixed project-template tests to run with unreleased PTB to better detect issues pre-release

doc/user_guide/getting_started.rst

@@ -37,7 +37,13 @@ Use the following command to create a new project:
 .. code-block:: shell
 
    cookiecutter https://github.com/exasol/python-toolbox.git \
-     --directory project-template
+    --checkout <latest-tag> --directory project-template
+
+.. note::
+
+    Without option :code:`--checkout` cookiecutter will use the main branch of the PTB. In order
+    to get reliable and reproducible results, we recommend using the tag of PTB's latest released
+    version instead.
 
 **2. Follow the interactive project setup prompt**
 

exasol/toolbox/templates/github/workflows/merge-gate.yml

@@ -11,9 +11,25 @@ jobs:
     permissions:
       contents: read
 
+  run-slow-tests:
+    name: Run Slow Tests
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+
+    # Even though the environment "manual-approval" will be created automatically,
+    # it still needs to be configured to require interactive review.
+    # See project settings on GitHub (Settings / Environments / manual-approval).
+    environment: manual-approval
+    steps:
+      - name: Tests
+        run: echo "Slow tests approved"
+
   slow-checks:
     name: Slow
+    needs: [ run-slow-tests ]
     uses: ./.github/workflows/slow-checks.yml
+    secrets: inherit
     permissions:
       contents: read