Update dependencies 2024-05-16 and Python-Toolbox (#134)

exasol · May 17, 2024 · 16d8d3a · 16d8d3a
1 parent 4eff408
commit 16d8d3a
Show file tree

Hide file tree

Showing 13 changed files with 570 additions and 141 deletions.
diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml
@@ -0,0 +1,38 @@
+name: Build & Publish
+
+on:
+  workflow_call:
+    secrets:
+      PYPI_TOKEN:
+          required: true
+
+jobs:
+
+  cd-job:
+    name: Continues Delivery
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+
+      - name: Build Artifacts
+        run: poetry build
+
+      - name: PyPi Release
+        env:
+          POETRY_HTTP_BASIC_PYPI_USERNAME: "__token__"
+          POETRY_HTTP_BASIC_PYPI_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
+        run: poetry publish
+
+      - name: GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: >
+          gh release create ${GITHUB_REF_NAME}
+          --title ${GITHUB_REF_NAME}
+          --notes-file ./doc/changes/changes_${GITHUB_REF_NAME}.md
+          dist/*
diff --git a/.github/workflows/check-release-tag.yml b/.github/workflows/check-release-tag.yml
@@ -0,0 +1,21 @@
+name: Check Release Tag
+
+on: workflow_call
+
+jobs:
+
+  check-tag-version-job:
+
+    name: Check Tag Version
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+
+      - name: Check Tag Version
+        # make sure the pushed/created tag matched the project version
+        run: "[[ `poetry version --short` == ${{ github.ref_name }} ]]"
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -0,0 +1,114 @@
+name: Checks
+
+on: workflow_call
+
+jobs:
+
+  version-check-job:
+    name: Version Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+
+      - name: Check Version(s)
+        run: poetry run version-check  exasol/bucketfs/version.py
+
+  build-documentation-job:
+    name: Build Documentation
+    needs: [version-check-job]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+
+      - name: Build Documentation
+        run: |
+          poetry run python -m nox -s build-docs
+
+  lint-job:
+    name: Linting (Python-${{ matrix.python-version }})
+    needs: [version-check-job]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: poetry run nox -s lint
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: .lint.txt
+          path: .lint.txt
+
+  type-check-job:
+    name: Type Checking (Python-${{ matrix.python-version }})
+    needs: [version-check-job]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: poetry run nox -s type-check
+
+  tests-job:
+    name: Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
+    needs: [build-documentation-job, lint-job, type-check-job]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        exasol-version: ["7.1.9"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: poetry run nox -s coverage -- -- --db-version ${{ matrix.exasol-version }}
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: .coverage
+          path: .coverage
+
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -9,12 +9,12 @@ jobs:
 
   check-tag-version-job:
     name: Check Release Tag
-    uses: exasol/python-toolbox/.github/workflows/check-release-tag.yml@0.3.0
+    uses: ./.github/workflows/check-release-tag.yml
 
   ci-job:
     name: Checks
     needs: [ check-tag-version-job ]
-    uses: exasol/python-toolbox/.github/workflows/checks.yml@0.3.0
+    uses: ./.github/workflows/checks.yml
 
   tests-job:
     name: Tests (Python-${{ matrix.python-version }})
@@ -48,8 +48,12 @@ jobs:
         run: poetry run pytest tests
 
   cd-job:
-    name: Continues Delivery
-    needs: [ ci-job, tests-job ]
-    uses: exasol/python-toolbox/.github/workflows/build-and-publish.yml@0.3.0
+    name: Continuous Delivery
+    needs: [ ci-job ]
+    uses: ./.github/workflows/build-and-publish.yml
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
 
   ci-job:
     name: Checks
-    uses: exasol/python-toolbox/.github/workflows/checks.yml@0.3.0
+    uses: ./.github/workflows/checks.yml
 
   tests-job:
     name: Tests (Python-${{ matrix.python-version }})
@@ -64,3 +64,7 @@ jobs:
           SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
         run: poetry run pytest test_saas
 
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,27 @@
+name: Publish Documentation
+
+on: workflow_call
+
+jobs:
+
+  documentation-job:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+
+      - name: Build Documentation
+        run: |
+          poetry run python -m nox -s build-docs
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4.6.0
+        with:
+          branch: gh-pages
+          folder: .html-documentation
+          git-config-name: Github Action
+          git-config-email: opensource@exasol.com
diff --git a/.github/workflows/pr_merge.yml → .github/workflows/pr-merge.yml b/.github/workflows/pr_merge.yml → .github/workflows/pr-merge.yml
@@ -10,7 +10,15 @@ jobs:
 
   ci-job:
     name: Checks
-    uses: exasol/python-toolbox/.github/workflows/checks.yml@0.3.0
+    uses: ./.github/workflows/checks.yml
+
+  publish-docs:
+    name: Publish Documentation
+    uses: ./.github/workflows/gh-pages.yml
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml
 
   tests-job:
     name: Tests (Python-${{ matrix.python-version }})
@@ -43,6 +51,3 @@ jobs:
       - name: Run Tests
         run: poetry run pytest tests
 
-  publish-docs:
-    name: Publish Documentation
-    uses: exasol/python-toolbox/.github/workflows/gh-pages.yml@0.3.0
diff --git a/.github/workflows/report.yml b/.github/workflows/report.yml
@@ -0,0 +1,53 @@
+name: Status Report
+
+on:
+  workflow_call:
+    secrets:
+      ALTERNATIVE_GITHUB_TOKEN:
+        required: false
+
+jobs:
+
+  report:
+    name: Generate Status Report
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.ALTERNATIVE_GITHUB_TOKEN ||  secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.12.0
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: ./artifacts
+
+      - name: Copy Artifacts into Root Folder
+        working-directory: ./artifacts
+        run: |
+          cp .coverage/.coverage ../
+          cp .lint.txt/.lint.txt ../
+
+      - name: Generate Report
+        run: poetry run nox -s report -- -- --format json | tee metrics.json
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: metrics.json
+          path: metrics.json
+
+      - name: Generate GitHub Summary
+        run: |
+          echo -e "# Summary\n" >> $GITHUB_STEP_SUMMARY
+          poetry run nox -s report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
+          echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
+          poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
+          echo  -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY
+          cat .lint.txt >> $GITHUB_STEP_SUMMARY
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -1 +1,5 @@
-# Unreleased
+# Unreleased
+
+## Internal
+- Updated lockfile
+- Update workflows to align with used exasol-toolbox version (0.12.0)