Add metrics support

* Add support for reporting project metrics
* Add `report` task
* Add metrics workflow
* Update workflows
* Update documentation
* Update templates
* Update dependencies
* Remove scriv support

Related PR/Issues:
* #48 

---------
Co-authored-by: Umit Cavus Buyuksahin <ucbuyuksahin@gmail.com>

Author: Nicoretti

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -6,9 +6,12 @@
 * [ ] Is the title of the Pull Request correct?
 * [ ] Is the title of the corresponding issue correct?
 * [ ] Have you updated the changelog?
+* [ ] Have you updated the templates?
 * [ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
 * [ ] Are you mentioning the issue which this PullRequest fixes ("Fixes...")
 
+Note: If any of the above is not relevant to your PR just check the box.
+
 ## 🔐 Security 
 ## 🐞 Bug 
 ## ✨ Feature   

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

@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@main
+        uses: ./.github/actions/python-environment
 
       - name: Build Artifacts
         run: poetry build

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

@@ -14,7 +14,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@main
+        uses: ./.github/actions/python-environment
 
       - name: Check Tag Version
         # make sure the pushed/created tag matched the project version

.github/workflows/checks.yml

@@ -19,63 +19,69 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@main
+        uses: ./.github/actions/python-environment
 
       - name: Check Version(s)
         run: poetry run version-check `poetry run python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
 
   build-documentation-job:
     name: Build Documentation
-    needs: [version-check-job]
+    needs: [ version-check-job ]
     runs-on: ubuntu-latest
 
     steps:
-    - name: SCM Checkout
-      uses: actions/checkout@v3
+      - name: SCM Checkout
+        uses: actions/checkout@v3
 
-    - name: Setup Python & Poetry Environment
-      uses: exasol/python-toolbox/.github/actions/python-environment@main
+      - name: Setup Python & Poetry Environment
+        uses: ./.github/actions/python-environment
 
-    - name: Build Documentation
-      run: |
-        poetry run python -m nox -s build-docs
+      - name: Build Documentation
+        run: |
+          poetry run python -m nox -s build-docs
 
   lint-job:
     name: Linting (Python-${{ matrix.python-version }})
-    needs: [version-check-job]
+    needs: [ version-check-job ]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        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@main
+        uses: ./.github/actions/python-environment
         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]
+    needs: [ version-check-job ]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        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@main
+        uses: ./.github/actions/python-environment
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -84,24 +90,30 @@ jobs:
 
   tests-job:
     name: Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
-    needs: [build-documentation-job, lint-job, type-check-job]
+    needs: [ build-documentation-job, lint-job, type-check-job ]
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{ secrets.ALTERNATIVE_GITHUB_TOKEN ||  secrets.GITHUB_TOKEN }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
-        exasol-version: ["7.1.9"]
+        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@main
+        uses: ./.github/actions/python-environment
         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

.github/workflows/ci-cd.yml

@@ -9,17 +9,20 @@ jobs:
 
   check-tag-version-job:
     name: Check Release Tag
-    uses: exasol/python-toolbox/.github/workflows/check-release-tag.yml@main
+    uses: ./.github/workflows/check-release-tag.yml
 
   ci-job:
     name: Checks
     needs: [ check-tag-version-job ]
-    uses: exasol/python-toolbox/.github/workflows/checks.yml@main
+    uses: ./.github/workflows/checks.yml
 
   cd-job:
     name: Continues Delivery
     needs: [ ci-job ]
-    uses: exasol/python-toolbox/.github/workflows/build-and-publish.yml@main
+    uses: ./.github/workflows/build-and-publish.yml
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml

.github/workflows/ci.yml

@@ -8,13 +8,15 @@ on:
       - "main"
       - "master"
   pull_request:
-    types: [opened, reopened]
+    types: [ opened, reopened ]
   schedule:
     # “At 00:00 on every 7th day-of-month from 1 through 31.” (https://crontab.guru)
     - cron: "0 0 1/7 * *"
 
 jobs:
-
   ci-job:
-    name: Checks
-    uses: exasol/python-toolbox/.github/workflows/checks.yml@main
+    uses: ./.github/workflows/checks.yml
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml

.github/workflows/gh-pages.yml

@@ -12,7 +12,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@main
+        uses: ./.github/actions/python-environment
 
       - name: Build Documentation
         run: |

.github/workflows/pr-merge.yml

@@ -10,8 +10,12 @@ jobs:
 
   ci-job:
     name: Checks
-    uses: exasol/python-toolbox/.github/workflows/checks.yml@main
+    uses: ./.github/workflows/checks.yml
 
   publish-docs:
     name: Publish Documentation
-    uses: exasol/python-toolbox/.github/workflows/gh-pages.yml@main
+    uses: ./.github/workflows/gh-pages.yml
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml

.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: ./.github/actions/python-environment
+
+      - 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@v3
+        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

.gitignore

@@ -1,3 +1,6 @@
+.lint.json
+.lint.txt
+
 odbcconfig/odbcinst.ini
 
 .html-documentation