Add readme_md

This commit is contained in:
Mika 2026-02-04 14:46:48 +00:00
parent 188da4dffd
commit 7b0b6972e3

94
readme_md Normal file
View file

@ -0,0 +1,94 @@
# Policy v1.1 Decision Table
## Überblick
Dieses Repository dokumentiert und implementiert das Experiment **policy_v1_1_decision_table**. Ziel ist die Entwicklung einer klar definierten Entscheidungstabelle zur Klassifizierung von Unknowns in der Continuous Integration (CI) sowie die Analyse des Rerun-Effekts anhand von Audit-Daten.
Weitere Informationen und Hintergrundanalyse:
[Artikel auf donau2space.de](https://donau2space.de/tag-139-unknowns-sind-jetzt-kein-nebel-mehr-meine-policy-v1-1-bekommt-eine-klare-entscheidungstabelle/)
[Git Repository](https://git.donau2space.de/Mika/policy_v1_1_decision_table)
## Hinweis
Alle Inhalte wurden per KI generiert.
Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko.
Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
## Inhalt des Repositories
Das Repository umfasst drei zentrale Artefakte:
### 1. audit_analysis
- **Art:** Python-Skript
- **Zielplattform:** Linux Userspace
- **Sprache:** Python
- **Zweck:** Analyse der Datei *audit.csv* und Klassifizierung von Unknowns nach definierten Regeln.
- **API-Funktionen:**
- `analyze_audit(file_path)` Analysiert die Audit-Daten und erzeugt einen Klassifikationsbericht.
- **Datenstrukturen:**
- `classification_report` (Typ JSON)
- Felder: `class`, `percentage`, `action`
### 2. rerun_analysis
- **Art:** Python-Skript
- **Zielplattform:** Linux Userspace
- **Sprache:** Python
- **Zweck:** Berechnung und Bewertung der Rerun-Effekte aus Audit-Daten.
- **API-Funktionen:**
- `calculate_rerun_effects(audit_data)` Ermittelt die Auswirkungen von Reruns auf Messergebnisse.
- **Datenstrukturen:**
- `rerun_analysis_results` (Typ JSON)
- Felder: `helps`, `shifts`, `hurts`
### 3. decision_table
- **Art:** Dokumentation
- **Ziel:** Mixed Environment
- **Sprache:** Nicht anwendbar
- **Zweck:** Definition klarer Entscheidungsregeln für PASS/WARN/FAIL auf Basis der Analyseergebnisse.
## Installation & Nutzung
Dieses Repository enthält Python-Skripte, die direkt im Linux-Userspace verwendet werden können.
### Voraussetzungen
- Python ≥ 3.8
- Installierte Pakete gemäß *requirements.txt* (falls vorhanden)
### Installation
1. Repository klonen:
```bash
git clone https://git.donau2space.de/Mika/policy_v1_1_decision_table.git
cd policy_v1_1_decision_table
```
2. Optional: Virtuelle Umgebung anlegen:
```bash
python3 -m venv venv
source venv/bin/activate
```
3. Abhängigkeiten installieren:
```bash
pip install -r requirements.txt
```
### Nutzung
Analysedurchlauf mit Audit-Daten:
```bash
python audit_analysis.py --file audit.csv
```
Rerun-Effekte berechnen:
```bash
python rerun_analysis.py --input audit_results.json
```
## Typische Use-Cases
- Bewertung von Build-Ergebnissen mit unbekannter Klassifikation.
- Berechnung von Effekten mehrfach ausgeführter Pipelines.
- Validierung und Pflege einer Entscheidungstabelle für CI-Automatisierung.
## Struktur & mögliche Erweiterungen
- Ordner `src/` enthält die Python-Skripte für Datenauswertung.
- Ordner `docs/` enthält die Entscheidungstabelle und begleitende Dokumentation.
- Erweiterungen:
- Integration zusätzlicher Datenquellen (z.B. Jenkins-Logs).
- Erweiterung der Entscheidungstabelle um probabilistische Klassifikationen.
- Ergänzung um Web-Dashboard zur Visualisierung der Analyse.
## Lizenz
Dieses Projekt steht unter der **MIT-Lizenz**.
Die Inhalte wurden automatisch durch ein KI-System erzeugt und werden ohne Gewähr bereitgestellt.