Merge pull request #18 from telexintegrations/ci/cd

fix(ci): fix attempt at installation errors

Author: iamprecieee

.github/workflows/deploy.yml

@@ -0,0 +1,26 @@
+name: CD pipeline to auto-deploy on merges to main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  auto-deploy:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    steps:
+      - name: deploy app
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          script: |
+            cd commit-quality-monitor
+            git pull origin main
+            source ./venv/bin/activate
+            pip install -r requirements.txt
+            sudo systemctl restart fastapi
+            sudo systemctl restart nginx

.github/workflows/pytest.yml

@@ -0,0 +1,27 @@
+name: CI pipeline to run pytest on pull requests
+
+on:
+  pull_request:
+    branches:
+      - staging
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository for workflow access
+        uses: actions/checkout@v4
+
+      - name: set up python environment
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.12'
+
+      - name: install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: run tests
+        run: |
+          pytest

README.md

@@ -18,7 +18,7 @@ Git Commit Quality Monitor analyzes commit messages in real-time, providing inst
 
 ### Prerequisites
 
-- Python 3.8+
+- Python 3.12
 - FastAPI
 - scikit-learn
 - Git (for development)
@@ -75,7 +75,6 @@ cp .env.example .env
 | HOST | Server host | 0.0.0.0 |
 | PORT | Server port | 8000 |
 | TELEX_WEBHOOK_URL | Telex webhook URL | https://ping.telex.im/v1/webhooks |
-| SLACK_URL | Slack webhook URL for notifications | https://hooks.slack.com/... |
 | APP_LOGO_URL | URL for app logo | https://example.com/logo.png |
 | APP_URL | Application URL | https://your-app.com |
 | TARGET_URL | Telex target URL | https://your-app.com/webhook/telex |
@@ -248,9 +247,9 @@ You can customize the analyzer through Telex integration settings:
 ```json
 {
     "feat": [
-        "feat(ui): add dark mode toggle",
-        "feat(api): implement rate limiting"
-    ]
+        "feat(auth): implement JWT authentication flow\n\nImplemented JWT-based authentication with token expiration handling to secure user sessions.",
+        "feat(ui): add dark mode toggle with system preference detection\n\nAdded dark mode toggle that automatically adjusts based on system settings for improved user experience.",
+    ],
 }
 ```
 

requirements.txt

@@ -1,56 +1,56 @@
-annotated-types==0.7.0
-anyio==4.8.0
-black==25.1.0
-certifi==2025.1.31
-click==8.1.8
-dnspython==2.7.0
-email_validator==2.2.0
-fastapi==0.115.8
-fastapi-cli==0.0.7
-h11==0.14.0
-httpcore==1.0.7
-httptools==0.6.4
-httpx==0.28.1
-idna==3.10
-iniconfig==2.0.0
-itsdangerous==2.2.0
-Jinja2==3.1.5
-joblib==1.4.2
-markdown-it-py==3.0.0
-MarkupSafe==3.0.2
-mdurl==0.1.2
-mypy-extensions==1.0.0
-nltk==3.9.1
-numpy==2.2.3
-orjson==3.10.15
-packaging==24.2
-pathspec==0.12.1
-platformdirs==4.3.6
-pluggy==1.5.0
-pydantic==2.10.6
-pydantic-extra-types==2.10.2
-pydantic-settings==2.7.1
-pydantic_core==2.27.2
-Pygments==2.19.1
-pytest==8.3.4
-python-dotenv==1.0.1
-python-multipart==0.0.20
-PyYAML==6.0.2
-regex==2024.11.6
-rich==13.9.4
-rich-toolkit==0.13.2
-scikit-learn==1.6.1
-scipy==1.15.2
-shellingham==1.5.4
-sniffio==1.3.1
-starlette==0.45.3
-textblob==0.19.0
-threadpoolctl==3.5.0
-tqdm==4.67.1
-typer==0.15.1
-typing_extensions==4.12.2
-ujson==5.10.0
-uvicorn==0.34.0
-uvloop==0.21.0
-watchfiles==1.0.4
-websockets==15.0
+annotated-types
+anyio
+black
+certifi
+click
+dnspython
+email_validator
+fastapi
+fastapi-cli
+h11
+httpcore
+httptools
+httpx
+idna
+iniconfig
+itsdangerous
+Jinja2
+joblib
+markdown-it-py
+MarkupSafe
+mdurl
+mypy-extensions
+nltk
+numpy
+orjson
+packaging
+pathspec
+platformdirs
+pluggy
+pydantic
+pydantic-extra-types
+pydantic-settings
+pydantic_core
+Pygments
+pytest
+python-dotenv
+python-multipart
+PyYAML
+regex
+rich
+rich-toolkit
+scikit-learn
+scipy
+shellingham
+sniffio
+starlette
+textblob
+threadpoolctl
+tqdm
+typer
+typing_extensions
+ujson
+uvicorn
+uvloop
+watchfiles
+websockets

src/config/config.py

@@ -3,17 +3,17 @@
 
 
 class Settings(BaseSettings):
-    allowed_origins: str
-    allowed_hosts: str
-    host: str
-    port: int
-    reload_value: str
-    telex_webhook_url: str
+    allowed_origins: str = "http://test"
+    allowed_hosts: str = "test"
+    host: str = "127.0.0.1"
+    port: int = 8000
+    reload_value: str = "true"
+    telex_webhook_url: str = "https://example.com/telex"
     curl_command: str | None = "curl" # might require path/to/curl e.g. `/usr/bin/curl`
-    app_logo_url: str
-    app_url: str
-    target_url: str
-    background_color_hexcode: str
+    app_logo_url: str = "https://example.com/logo.png"
+    app_url: str = "https://example.com"
+    target_url: str = "https://example.com/target"
+    background_color_hexcode: str = "#FFFFFF"
 
     model_config = SettingsConfigDict(env_file=".env")
 

src/core/analyzer.py

@@ -47,11 +47,11 @@ def _apply_data_settings(self):
         """
         for setting in self.settings:
             if setting["label"] == "commit_types":
-                self.commit_types.update(ast.literal_eval(setting["default"])) if setting["default"] else self.commit_types
+                self.commit_types.update(ast.literal_eval(setting["default"].replace("\n", "\\n"))) if setting["default"] else self.commit_types
             if setting["label"] == "example_commits":
-                self.example_commits.update(ast.literal_eval(setting["default"])) if setting["default"] else self.example_commits
+                self.example_commits.update(ast.literal_eval(setting["default"].replace("\n", "\\n"))) if setting["default"] else self.example_commits
             if setting["label"] == "training_data":
-                self.commit_training_data.update(ast.literal_eval(setting["default"])) if setting["default"] else self.commit_training_data
+                self.commit_training_data.update(ast.literal_eval(setting["default"].replace("\n", "\\n"))) if setting["default"] else self.commit_training_data
             if setting["label"] == "slack_url":
                 self.slack_url = setting["default"]