[DOP-11712] add github workflow for code analysis (#2)

* [DOP-11712] add github workflow for code analysis

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,92 @@
+name: Code analysis
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches-ignore:
+      - master
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+env:
+  # flake8-commas is failing on Python 3.12
+  DEFAULT_PYTHON: '3.11'
+
+jobs:
+  linters:
+    name: Linters
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Install system dependencies
+        # this step is needed for successful installation of "bonsai" library in python dependencies
+        run: sudo apt-get update && sudo apt-get install -y libldap2-dev libsasl2-dev
+
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+
+      - name: Cache poetry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pypoetry
+          key: ${{ runner.os }}-python-${{ env.DEFAULT_PYTHON }}-codeql-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-python-${{ env.DEFAULT_PYTHON }}-codeql-${{ hashFiles('**/poetry.lock') }}
+            ${{ runner.os }}-python-${{ env.DEFAULT_PYTHON }}-codeql-
+            ${{ runner.os }}-python
+            ${{ runner.os }}-
+
+      - name: Install dependencies
+        run: |
+          poetry install --no-root --all-extras --with dev --without test
+
+      - name: Run flake8
+        run: poetry run flake8 syncmaster/
+
+      - name: Run mypy
+        run: poetry run mypy --config-file ./pyproject.toml ./syncmaster/app
+
+  codeql:
+    name: CodeQL
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+    # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: python
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: /language:python

.pre-commit-config.yaml

@@ -130,3 +130,9 @@ repos:
     hooks:
       - id: check-hooks-apply
       - id: check-useless-excludes
+
+ci:
+  skip:
+    - mypy  # checked with Github Actions
+    - chmod  # failing in pre-commit.ci
+    - docker-compose-check  # cannot run on pre-commit.ci

docker-compose.yml

@@ -136,5 +136,6 @@ services:
 networks:
   network:
 
+
 volumes:
   postgres_data: