Infrastructure update (#78)

* CI workflows update

* Add  and configure mkdocs-adr-summary-macro

Signed-off-by: Federico Busetti <[email protected]>

Author: febus982

.bandit.yml

@@ -0,0 +1,24 @@
+version: "2"
+plugins:
+  bandit:
+    enabled: true
+  sonar-python:
+    enabled: true
+exclude_patterns:
+  - "spec/"
+  - "!spec/support/helpers"
+  - "config/"
+  - "alembic/"
+  - "grpc_app/generated/"
+  - "db/"
+  - "dist/"
+  - "features/"
+  - "**/node_modules/"
+  - "script/"
+  - "**/spec/"
+  - "**/test/"
+  - "**/tests/"
+  - "Tests/"
+  - "**/vendor/"
+  - "**/*_test.go"
+  - "**/*.d.ts"

.codeclimate.yml

@@ -37,7 +37,7 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install poetry
           poetry config virtualenvs.create false
-          poetry install --no-root --with dev
+          make dev-dependencies
 
       - name: Build static pages
         run: make docs-build

.github/workflows/github-pages.yml

@@ -0,0 +1,32 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Bandit checks
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  bandit:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Security check - Bandit
+      uses: ioggstream/[email protected]
+      with:
+        project_path: .
+        config_file: .bandit.yml
+
+    # This is optional
+    - name: Security check report artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: Security report
+        path: output/security_report.txt

.github/workflows/python-3.11.yml

@@ -8,15 +8,17 @@ on:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
-  quality:
+  format:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.11
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: "3.11"
     - name: Install dependencies

.github/workflows/python-3.9.yml

@@ -8,15 +8,17 @@ on:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
-  quality:
+  lint:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.11
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: "3.11"
     - name: Install dependencies

.github/workflows/python-bandit.yml

@@ -8,15 +8,17 @@ on:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
   quality:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.11
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: "3.11"
     - name: Install dependencies
@@ -26,8 +28,7 @@ jobs:
         poetry config virtualenvs.create false
         make dev-dependencies
     - name: Test & publish code coverage
-      uses: paambaati/[email protected]
-      if: env.CC_TEST_REPORTER_ID != null
+      uses: paambaati/[email protected]
       env:
         CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE_REPORTER_ID }}
       with:

.github/workflows/python-code-style.yml

@@ -1,24 +1,29 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python 3.10
+name: Python tests
 
 on:
   push:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        version: ["3.9", "3.10", "3.11"]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.version }}
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.10"
+        python-version: "${{ matrix.version }}"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip