Refactoring/#175 updated ptb incl. git hub workflows (#176)

* #175: Updated PTB incl. GitHub workflows Updated dependencies and default nox task * Updated GitHub workflows
exasol · Nov 29, 2024 · cb2c637 · cb2c637
1 parent 6ac26d6
commit cb2c637
Show file tree

Hide file tree

Showing 17 changed files with 369 additions and 254 deletions.
diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml
@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@0.14.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0
 
       - name: Build Artifacts
         run: poetry build

diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -0,0 +1,24 @@
+name: CD
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+
+  check-tag-version-job:
+    name: Check Release Tag
+    uses: ./.github/workflows/check-release-tag.yml
+
+  cd-job:
+    name: Continuous Delivery
+    uses: ./.github/workflows/build-and-publish.yml
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  publish-docs:
+    needs: [ cd-job ]
+    name: Publish Documentation
+    uses: ./.github/workflows/gh-pages.yml
+
diff --git a/.github/workflows/check-release-tag.yml b/.github/workflows/check-release-tag.yml
@@ -14,7 +14,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@0.14.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0
 
       - name: Check Tag Version
         # make sure the pushed/created tag matched the project version

diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -1,11 +1,15 @@
 name: Checks
 
-on: workflow_call
+on:
+  workflow_call:
+    secrets:
+      ALTERNATIVE_GITHUB_TOKEN:
+        required: false
 
 jobs:
 
-  version-check-job:
-    name: Version Check & Build Documentation
+  Version-Check:
+    name: Version
     runs-on: ubuntu-latest
 
     steps:
@@ -15,41 +19,133 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@0.14.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0
 
       - name: Check Version(s)
-        run: poetry run version-check  exasol/bucketfs/version.py
+        run: |
+          poetry run version-check `poetry run python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
+
+  Documentation:
+    name: Docs
+    needs: [ Version-Check ]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
 
       - name: Build Documentation
         run: |
           poetry run python -m nox -s docs:build
 
-  lint-job:
-    name: Linting and Type checks (Python-${{ matrix.python-version }})
-    needs: [version-check-job]
+  Lint:
+    name: Linting (Python-${{ matrix.python-version }})
+    needs: [ Version-Check ]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
 
     steps:
       - name: SCM Checkout
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@0.14.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Run Tests
+      - name: Run lint
         run: poetry run nox -s lint:code
 
+      - name: Upload Artifacts
+        uses: actions/[email protected]
+        with:
+          name: lint-python${{ matrix.python-version }}
+          path: .lint.txt
+          include-hidden-files: true
+
+  Type-Check:
+    name: Type Checking (Python-${{ matrix.python-version }})
+    needs: [ Version-Check ]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+
       - name: Run type-check
         run: poetry run nox -s lint:typing
 
+  Security:
+    name: Security Checks (Python-${{ matrix.python-version }})
+    needs: [ Version-Check ]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run security linter
+        run: poetry run nox -s lint:security
+
       - name: Upload Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4.4.0
         with:
-          name: .lint.txt
-          path: .lint.txt
+          name: security-python${{ matrix.python-version }}
+          path: .security.json
+          include-hidden-files: true
+
+  Tests:
+    name: Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
+    needs: [ Documentation, Lint, Type-Check, Security ]
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.ALTERNATIVE_GITHUB_TOKEN ||  secrets.GITHUB_TOKEN }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+        exasol-version: ["7.1.9"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests and Compute Coverage
+        run: poetry run nox -s test:coverage -- -- --db-version ${{ matrix.exasol-version }}
+
+      - name: Upload Artifacts
+        uses: actions/[email protected]
+        with:
+          name: coverage-python${{ matrix.python-version }}
+          path: .coverage
+          include-hidden-files: true
+
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,86 +8,10 @@ on:
 
 jobs:
 
-  ci-job:
-    name: Checks
-    uses: ./.github/workflows/checks.yml
+  CI:
+    uses: ./.github/workflows/merge-gate.yml
+    secrets: inherit
 
-  fast-tests:
-    name: Tests (Python-${{ matrix.python-version }})
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.9", "3.10", "3.11"]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected]
-        with:
-          python-version: ${{ matrix.python-version }}
-          poetry-version: 1.2.2
-
-      - name: Run Unit Tests
-        run: poetry run nox -s test:unit
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: .coverage
-          path: .coverage
-
-  metrics:
-    needs: [ fast-tests ]
+  Metrics:
+    needs: [ CI ]
     uses: ./.github/workflows/report.yml
-
-  gate-1:
-    name: Gate 1 - Regular CI
-    needs: [ fast-tests ]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Branch Protection
-        run: true
-
-  slow-test-detection:
-    name: Run Slow or Expensive Tests (e.g. SaaS)?
-    runs-on: ubuntu-latest
-    steps:
-      - name: Detect Slow Tests
-        run: true
-    environment:
-      slow-tests
-
-  run-slow-tests:
-    name: Run Slow or Expensive Tests (e.g. SaaS) if Requested
-    runs-on: ubuntu-latest
-    needs: [ slow-test-detection ]
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.9", "3.10", "3.11"]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected]
-        with:
-          python-version: ${{ matrix.python-version }}
-          poetry-version: "1.2.2"
-
-      - name: Run Integration Tests
-        env:
-          SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
-          SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
-          SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
-        run: poetry run pytest --backend=all test/integration
-
-  gate-2:
-    name: Gate 2 - Allow Merge
-    runs-on: ubuntu-latest
-    needs: [ run-slow-tests ]
-    steps:
-      - name: Branch Protection
-        run: true
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -1,6 +1,8 @@
 name: Publish Documentation
 
-on: workflow_call
+on: 
+  workflow_call:
+  workflow_dispatch:
 
 jobs:
 
@@ -10,13 +12,15 @@ jobs:
     steps:
       - name: SCM Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@0.14.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0
 
       - name: Build Documentation
         run: |
-          poetry run python -m nox -s build-docs
+          poetry run nox -s docs:multiversion
 
       - name: Deploy
         uses: JamesIves/[email protected]