mindnet/docs/dev_workflow.md

157 lines
4.8 KiB
Markdown
Raw Normal View History

2025-12-07 15:49:44 +01:00
# Mindnet v2.2 – Entwickler-Workflow
**Datei:** `DEV_WORKFLOW.md`
2025-12-07 18:53:13 +01:00
**Stand:** 2025-12-07 (Aktualisiert nach WP-04b)
2025-12-07 15:49:44 +01:00
Dieses Handbuch beschreibt den Entwicklungszyklus zwischen **Windows PC** (IDE), **Raspberry Pi** (Gitea) und **Beelink** (Runtime/Server).
---
## 1. Die Architektur
* **Windows 11 (VS Code):** Hier schreibst du Code. **Nie** direkt auf `main` arbeiten!
* **Raspberry Pi (Gitea):** Der Tresor. Speichert den Code und verwaltet Versionen.
* **Beelink (Runtime):** Hier läuft die Software. Wir trennen strikt:
* **PROD (`~/mindnet`):** Läuft stabil auf `main`. **Port 8001**.
* **DEV (`~/mindnet_dev`):** Deine Spielwiese für Branches. **Port 8002**.
---
## 2. Der Zyklus: Von der Idee zum Release
### Phase 1: Entwicklung (Windows / VS Code)
Hier erstellst du die neue Funktion in einer sicheren Umgebung.
1. **Sicherstellen, dass Git bereit ist:**
* Öffne VS Code.
* Unten links in der blauen Leiste sollte der aktuelle Branch stehen (z.B. `main`).
2. **Branch erstellen (WICHTIG):**
2025-12-07 18:53:13 +01:00
* Klicke unten links auf den Branch-Namen.
* Wähle `+ Create new branch...`.
2025-12-07 15:49:44 +01:00
* Gib den Namen ein: `feature/was-ich-tue` (z.B. `feature/wp04b-explanation`).
* Drücke **Enter**.
3. **Sicherheits-Check:**
2025-12-07 18:53:13 +01:00
* Steht unten links jetzt dein Feature-Branch? **Nur dann darfst du Code ändern!**
2025-12-07 15:49:44 +01:00
4. **Coden:**
* Nimm deine Änderungen vor.
5. **Sichern & Hochladen:**
2025-12-07 18:53:13 +01:00
* **Source Control** Icon (Gabel-Symbol) -> Nachricht eingeben -> **Commit**.
* **Publish Branch** (oder "Sync Changes"), um den Branch zum Raspberry Pi (Gitea) zu senden.
2025-12-07 15:49:44 +01:00
---
### Phase 2: Testen (Beelink / `mindnet_dev`)
2025-12-07 18:53:13 +01:00
Hier prüfst du, ob dein neuer Code auf dem echten Server läuft.
2025-12-07 15:49:44 +01:00
1. **Einloggen:**
`ssh user@<BEELINK-IP>`
2. **In die Werkstatt gehen:**
`cd /home/llmadmin/mindnet_dev`
3. **Code holen:**
```bash
git fetch
2025-12-07 18:53:13 +01:00
# Tipp: 'git branch -r' zeigt alle verfügbaren Branches an
2025-12-07 15:49:44 +01:00
git checkout feature/wp04b-explanation
git pull
```
2025-12-07 18:53:13 +01:00
4. **Umgebung vorbereiten:**
2025-12-07 15:49:44 +01:00
```bash
source .venv/bin/activate
2025-12-07 18:53:13 +01:00
pip install -r requirements.txt # Nur nötig bei neuen Paketen
2025-12-07 15:49:44 +01:00
```
2025-12-07 18:53:13 +01:00
5. **Test-Server neustarten (WICHTIG):**
Falls noch ein alter Prozess läuft, musst du ihn beenden, damit der neue Code geladen wird.
* Drücke `Strg + C` falls der Server noch im Vordergrund läuft.
* Oder nutze `pkill -f "uvicorn app.main:app"` um Hintergrunde-Prozesse zu stoppen.
Starten auf **Port 8002**:
2025-12-07 15:49:44 +01:00
```bash
2025-12-07 18:53:13 +01:00
uvicorn app.main:app --host 0.0.0.0 --port 8002 --env-file .env
2025-12-07 15:49:44 +01:00
```
2025-12-07 18:53:13 +01:00
6. **Validieren:**
Führe deine Tests in einem **zweiten Terminal** aus:
2025-12-07 15:49:44 +01:00
```bash
2025-12-07 18:53:13 +01:00
# Beispiel für Smoke-Test gegen Dev-Port
python3 tests/test_explanation_smoke.py --url http://localhost:8002/query
2025-12-07 15:49:44 +01:00
```
---
### Phase 3: Release (Gitea / Raspberry Pi)
Wenn der Test auf Port 8002 erfolgreich war:
1. Öffne Gitea im Browser.
2025-12-07 18:53:13 +01:00
2. Erstelle einen **Pull Request** (Dein Branch -> `main`).
3. **Merge** den Pull Request.
2025-12-07 15:49:44 +01:00
---
### Phase 4: Deployment (Beelink / `mindnet`)
Jetzt bringen wir die Änderung in das Live-System (Port 8001).
1. **Deploy-Agent (Automatisch):**
Wenn dein `deploy.yml` aktiv ist, passiert das jetzt von selbst!
2. **Manuell (Falls nötig):**
```bash
cd /home/llmadmin/mindnet
git pull origin main
sudo systemctl restart mindnet-api
```
---
2025-12-07 18:53:13 +01:00
### Phase 5: Aufräumen (Optional aber empfohlen)
Damit das Chaos nicht wächst, löschen wir den fertigen Branch.
1. **Gitea:** Im Pull Request auf "Delete Branch" klicken.
2. **Beelink (Dev):**
```bash
cd ~/mindnet_dev
git checkout main
git pull
git branch -d feature/wp04b-explanation
```
3. **VS Code:**
* Auf `main` wechseln.
* `F1` -> `Git: Delete Branch` -> Branch auswählen.
---
2025-12-07 15:49:44 +01:00
## 3. Cheat Sheet: Die wichtigsten Befehle
| Wo? | Befehl | Was tut es? |
| :--- | :--- | :--- |
| **VS Code** | `Klick auf Branch-Namen` | Branch erstellen oder wechseln. |
| **VS Code** | `Sync Changes` | Lädt Code zu Gitea hoch. |
| **Beelink** | `cd ~/mindnet_dev` | Gehe in den Test-Ordner. |
| **Beelink** | `source .venv/bin/activate` | **Aktiviert Python-Umgebung.** |
2025-12-07 18:53:13 +01:00
| **Beelink** | `git fetch` | Aktualisiert die Liste der Remote-Branches. |
| **Beelink** | `git branch -r` | Zeigt alle Branches auf dem Server an. |
2025-12-07 15:49:44 +01:00
| **Beelink** | `git checkout <name>` | Wechsle auf einen anderen Branch. |
| **Beelink** | `uvicorn ... --port 8002` | Startet Test-Server (Dev). |
---
## 4. Sicherheitsregeln
2025-12-07 18:53:13 +01:00
1. **Niemals** in `~/mindnet` (Prod-Ordner) experimentieren. Dieser Ordner bleibt immer auf `main`.
2025-12-07 15:49:44 +01:00
2. **Niemals** beide Umgebungen auf denselben `COLLECTION_PREFIX` zeigen lassen.
* Prod `.env`: `COLLECTION_PREFIX="mindnet"`
* Dev `.env`: `COLLECTION_PREFIX="mindnet_dev"`
3. **Port-Disziplin:**
* **PROD:** Port 8001
* **DEV:** Port 8002