Doc/updated testing instructions (#58)

* Update testing instructions in developer guide
* Upload openapi.json in GitHub workflow
* Updated actions/checkout@v3 to v4
* Added option overwrite when uploading coverage

Author: ckunki

.github/workflows/build-and-publish.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
 
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]

.github/workflows/check-api-outdated.yml

@@ -1,4 +1,4 @@
-name: Check if OpenAPI is Outdated
+name: Open API
 
 on:
   push:
@@ -16,19 +16,28 @@ on:
 jobs:
 
   check-api-outdated:
-    name: Check if OpenAPI Generated From JSON is Outdated
+    name: Check API Outdated
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Display branch
+      - name: Display Branch and Download openapi.json
+        id: download
         run: |
           git branch
-          curl -s https://cloud.exasol.com/openapi.json
+          F="ci-$(date "+%y%m%d-%H%M").json"
+          curl -s https://cloud.exasol.com/openapi.json -o "$F"
+          echo json=$F >> "$GITHUB_OUTPUT"
+
+      - name: Upload openapi.json
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.download.outputs.json}}
+          path: ${{ steps.download.outputs.json}}
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]

.github/workflows/check-release-tag.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]

.github/workflows/checks.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -27,7 +27,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]
@@ -47,7 +47,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]
@@ -68,7 +68,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
     uses: ./.github/workflows/report.yml
 
   gate-1:
-    name: Regular
+    name: Gate 1 - Regular CI
     needs: [ ci-job ]
     runs-on: ubuntu-latest
     steps:
@@ -49,7 +49,7 @@ jobs:
       python-version: "3.10"
 
   gate-2:
-    name: Merge
+    name: Gate 2 - Allow Merge
     runs-on: ubuntu-latest
     needs: [ run-slow-tests ]
     steps:

.github/workflows/gh-pages.yml

@@ -9,7 +9,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]

.github/workflows/report.yml

@@ -17,7 +17,7 @@ jobs:
 
     steps:
       - name: SCM Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 

.github/workflows/run-tests.yml

@@ -45,3 +45,4 @@ jobs:
         with:
           name: .coverage
           path: .coverage
+          overwrite: true

doc/changes/unreleased.md

@@ -3,7 +3,12 @@
 ## Refactoring
 
 * #53: Separated long-running tests
+* Updated GitHub workflow to upload `openapi.json` as artifact
 
 ## Features
 
 * #55 Added publicly callable function finding the database id from its name.
+
+## Documentation
+
+* Updated instructions for triggering slow tests in Developer Guide

doc/developer_guide/developer_guide.md

@@ -72,7 +72,7 @@ Executing the integration tests requires the following environment variables to
 
 Some of the test cases verify connecting to a SaaS database instance and execution will take about 20 minutes.
 
-These test cases are disabled by default and will only be executed by adding a comment `[run-slow-tests]` to your pull request.
+The regular CI build will ask for a confirmation (aka. "review) before executing these tests.
 
 ## Creating a Release