Removes basic hook and rule check files.
Fixes Pr checks bug. Adds documentations.
This commit is contained in:
1 parent
95044caecd
commit
e3d6cd21be
5 files changed
+68
-53
No files matched your search
@@ -7,29 +7,29 @@ Test- und Beispiel-Repository für einen lokalen Dev-Platform-Stack mit:
|
|||||||
- **Webhook-Trigger von Gitea nach Jenkins**
|
- **Webhook-Trigger von Gitea nach Jenkins**
|
||||||
- **C++/CMake/Ninja Build**
|
- **C++/CMake/Ninja Build**
|
||||||
- **PR Policy Checks**
|
- **PR Policy Checks**
|
||||||
- **Docker-basierter CI-Agent**
|
- **Docker-basiertem CI-Agent**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Aktueller Funktionsumfang
|
## Aktueller Funktionsumfang
|
||||||
|
|
||||||
Dieses Repository und das zugehörige Jenkins/Gitea-Setup können aktuell:
|
Dieses Repository und das zugehörige Jenkins/Gitea-Setup können aktuell:
|
||||||
|
|
||||||
## SCM / Repository
|
### SCM / Repository
|
||||||
- Repository in **Gitea** hosten
|
- Repository in **Gitea** hosten
|
||||||
- Änderungen per **Git Push** empfangen
|
- Änderungen per **Git Push** empfangen
|
||||||
- **Pull Requests** in Gitea verwalten
|
- **Pull Requests** in Gitea verwalten
|
||||||
- Webhooks von Gitea an Jenkins senden
|
- Webhooks von Gitea an Jenkins senden
|
||||||
|
|
||||||
## Jenkins / CI
|
### Jenkins / CI
|
||||||
- Jenkins als **Multibranch Pipeline** verwenden
|
- Jenkins als **Multibranch Pipeline** verwenden
|
||||||
- Branches und Pull Requests automatisch erkennen
|
- Branches und Pull Requests automatisch erkennen
|
||||||
- Builds durch **Push Events** automatisch starten
|
- Builds durch **Push Events** automatisch starten
|
||||||
- Build-Status an Gitea zurückmelden
|
- Build-Status an Gitea zurückmelden
|
||||||
|
|
||||||
## Build-Umgebung
|
### Build-Umgebung
|
||||||
- Pipeline-Schritte in einem **Docker-Container** ausführen
|
- Pipeline-Schritte in einem **Docker-Container** ausführen
|
||||||
- dafür ein vordefiniertes CI-Image verwenden
|
- dafür ein vorbereitetes CI-Image verwenden
|
||||||
- folgende Tools im CI bereitstellen:
|
- folgende Tools im CI bereitstellen:
|
||||||
- `python3`
|
- `python3`
|
||||||
- `clang-format`
|
- `clang-format`
|
||||||
@@ -39,27 +39,15 @@ Dieses Repository und das zugehörige Jenkins/Gitea-Setup können aktuell:
|
|||||||
- `g++`
|
- `g++`
|
||||||
- `make`
|
- `make`
|
||||||
|
|
||||||
## C++ Projektbasis
|
### C++ Projektbasis
|
||||||
- minimales Beispielprogramm über `main.cpp`
|
- minimales Beispielprogramm über `main.cpp`
|
||||||
- Build mit **CMake**
|
- Build mit **CMake**
|
||||||
- Testausführung über **CTest**
|
- Testausführung über **CTest**
|
||||||
- Testdateien unter `tests/`
|
- Testdateien unter `tests/`
|
||||||
|
|
||||||
## PR Policy Checks
|
|
||||||
Für geänderte C/C++-Dateien werden in der CI geprüft:
|
|
||||||
|
|
||||||
- `.clang-format` muss im Repository vorhanden sein
|
|
||||||
- geänderte C/C++-Dateien müssen mit `clang-format` konform sein
|
|
||||||
- zu geänderten C/C++-Dateien muss ein passender Test unter `tests/` oder `test/` vorhanden sein
|
|
||||||
- Vergleich gegen den Zielbranch erfolgt robust über Git-Refs wie z. B.:
|
|
||||||
- `origin/main`
|
|
||||||
- `main`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Repository-Struktur
|
## Repository-Struktur
|
||||||
|
|
||||||
Beispielhaft verwendete Dateien:
|
|
||||||
|
|
||||||
```text
|
```text
|
||||||
.
|
.
|
||||||
@@ -77,7 +65,7 @@ Beispielhaft verwendete Dateien:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# CI / Jenkins Pipeline
|
## CI / Jenkins Pipeline
|
||||||
|
|
||||||
Die Jenkins-Pipeline umfasst aktuell diese Schritte:
|
Die Jenkins-Pipeline umfasst aktuell diese Schritte:
|
||||||
|
|
||||||
@@ -103,20 +91,39 @@ Die Jenkins-Pipeline umfasst aktuell diese Schritte:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Docker-basierter CI-Agent
|
## PR Policy Checks
|
||||||
|
|
||||||
|
Für geänderte C/C++-Dateien werden in der CI folgende Regeln geprüft:
|
||||||
|
|
||||||
|
- `.clang-format` muss im Repository vorhanden sein
|
||||||
|
- geänderte C/C++-Dateien müssen mit `clang-format` konform sein
|
||||||
|
- zu geänderten C/C++-Dateien muss ein passender Test unter `tests/` oder `test/` vorhanden sein
|
||||||
|
|
||||||
|
### Vergleichsbasis der Policy
|
||||||
|
|
||||||
|
Die Policy unterscheidet zwischen Pull-Request-Builds und normalen Branch-Builds:
|
||||||
|
|
||||||
|
- **bei Pull Requests** wird gegen den Zielbranch verglichen, z. B. `origin/main`
|
||||||
|
- **bei normalen Branch-Builds** wird auf eine lokale Vergleichsbasis zurückgefallen, z. B. `HEAD~1`, falls kein Zielbranch-Ref verfügbar ist
|
||||||
|
|
||||||
|
Damit funktioniert die Policy sowohl in PR-Builds als auch bei regulären Branch-Indexing- oder Branch-Build-Läufen.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Docker-basierter CI-Agent
|
||||||
|
|
||||||
Die Pipeline verwendet ein vorbereitetes Docker-Image statt bei jedem Lauf ein neues Build-Image zu erzeugen.
|
Die Pipeline verwendet ein vorbereitetes Docker-Image statt bei jedem Lauf ein neues Build-Image zu erzeugen.
|
||||||
|
|
||||||
## Beispiel
|
### Beispiel
|
||||||
Das Image wird lokal/auf dem Build-Host gebaut:
|
Das Image wird lokal oder auf dem Build-Host gebaut:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t lifemaps/ci-cpp:latest -f Dockerfile.ci .
|
docker build -t lifemaps/ci-cpp:latest -f Dockerfile.ci .
|
||||||
```
|
```
|
||||||
|
|
||||||
Danach nutzt Jenkins dieses Image als Agent.
|
Danach nutzt Jenkins dieses Image als Build-Agent.
|
||||||
|
|
||||||
## Vorteile
|
### Vorteile
|
||||||
- schnellere PR-Builds
|
- schnellere PR-Builds
|
||||||
- reproduzierbare Toolchain
|
- reproduzierbare Toolchain
|
||||||
- keine langen `apt install`-Phasen pro Build
|
- keine langen `apt install`-Phasen pro Build
|
||||||
@@ -124,7 +131,7 @@ Danach nutzt Jenkins dieses Image als Agent.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Branch- und PR-Workflow
|
## Branch- und PR-Workflow
|
||||||
|
|
||||||
Der aktuelle Workflow unterstützt:
|
Der aktuelle Workflow unterstützt:
|
||||||
|
|
||||||
@@ -141,24 +148,24 @@ Empfohlen ist:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Lokales Arbeiten
|
## Lokales Arbeiten
|
||||||
|
|
||||||
## Formatierung prüfen
|
### Formatierung prüfen
|
||||||
```bash
|
```bash
|
||||||
clang-format --dry-run --Werror main.cpp tests/test_main.cpp
|
clang-format --dry-run --Werror main.cpp tests/test_main.cpp
|
||||||
```
|
```
|
||||||
|
|
||||||
## Formatierung anwenden
|
### Formatierung anwenden
|
||||||
```bash
|
```bash
|
||||||
clang-format -i main.cpp tests/test_main.cpp
|
clang-format -i main.cpp tests/test_main.cpp
|
||||||
```
|
```
|
||||||
|
|
||||||
## CI-Policy lokal testen
|
### CI-Policy lokal testen
|
||||||
```bash
|
```bash
|
||||||
python3 ci/check_pr_policies.py
|
python3 ci/check_pr_policies.py
|
||||||
```
|
```
|
||||||
|
|
||||||
## Build lokal ausführen
|
### Build lokal ausführen
|
||||||
```bash
|
```bash
|
||||||
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug
|
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug
|
||||||
cmake --build build --parallel
|
cmake --build build --parallel
|
||||||
@@ -167,7 +174,7 @@ ctest --test-dir build --output-on-failure
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Voraussetzungen auf Jenkins-Seite
|
## Voraussetzungen auf Jenkins-Seite
|
||||||
|
|
||||||
Für das Setup werden u. a. folgende Jenkins-Plugins benötigt:
|
Für das Setup werden u. a. folgende Jenkins-Plugins benötigt:
|
||||||
|
|
||||||
@@ -189,7 +196,7 @@ Zusätzlich muss der Jenkins-Container Zugriff auf Docker haben, z. B. über:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Webhook / Automatischer Trigger
|
## Webhook / Automatischer Trigger
|
||||||
|
|
||||||
Gitea ist so konfiguriert, dass **Push Events** an Jenkins gemeldet werden.
|
Gitea ist so konfiguriert, dass **Push Events** an Jenkins gemeldet werden.
|
||||||
|
|
||||||
@@ -199,32 +206,26 @@ Beispiel-Endpunkt:
|
|||||||
https://jenkins.life-maps.com/gitea-webhook/post
|
https://jenkins.life-maps.com/gitea-webhook/post
|
||||||
```
|
```
|
||||||
|
|
||||||
Damit können:
|
Damit können automatisch Jenkins-Builds für Branches und Pull Requests ausgelöst werden.
|
||||||
- neue Branch-Commits
|
|
||||||
- PR-bezogene Änderungen
|
|
||||||
- Status-Updates
|
|
||||||
|
|
||||||
automatisch Jenkins-Builds auslösen.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Beispielziel des Repositories
|
## Beispielziel des Repositories
|
||||||
|
|
||||||
Dieses Repository dient aktuell als:
|
Dieses Repository dient aktuell als:
|
||||||
|
|
||||||
- Referenz für Jenkins/Gitea-Integration
|
- Referenz für Jenkins/Gitea-Integration
|
||||||
- Testumgebung für PR-Policies
|
- Testumgebung für PR-Policies
|
||||||
- Minimalbeispiel für C++/CMake-basierte CI
|
- Minimalbeispiel für C++/CMake-basierte CI
|
||||||
- Grundlage für spätere Erweiterungen, z. B. mit Qt
|
- Grundlage für weitere CI- und Policy-Erweiterungen
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Status
|
## Status
|
||||||
|
|
||||||
Aktuell ist das Setup geeignet für:
|
Aktuell ist das Setup geeignet für:
|
||||||
|
|
||||||
- Jenkins/Gitea-Webhook-Integration
|
- Jenkins/Gitea-Webhook-Integration
|
||||||
- Pull-Request-basierte CI
|
- Pull-Request-basierte CI
|
||||||
- C++/CMake/Ninja Beispielprojekte
|
- C++/CMake/Ninja Beispielprojekte
|
||||||
- Policy-basierte Qualitätsprüfungen im PR-Prozess
|
- Policy-basierte Qualitätsprüfungen im PR-Prozess
|
||||||
- Vorbereitung auf weitergehende Qt-Migrations- und CI-Themen
|
|
||||||
+22
-5
@@ -34,7 +34,10 @@ def git_ref_exists(ref: str) -> bool:
|
|||||||
except subprocess.CalledProcessError:
|
except subprocess.CalledProcessError:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
def resolve_target_ref() -> str:
|
def is_pull_request_build() -> bool:
|
||||||
|
return bool(os.environ.get("CHANGE_ID"))
|
||||||
|
|
||||||
|
def resolve_target_ref() -> str | None:
|
||||||
raw = os.environ.get("CHANGE_TARGET", "").strip()
|
raw = os.environ.get("CHANGE_TARGET", "").strip()
|
||||||
|
|
||||||
candidates = []
|
candidates = []
|
||||||
@@ -52,13 +55,27 @@ def resolve_target_ref() -> str:
|
|||||||
if git_ref_exists(ref):
|
if git_ref_exists(ref):
|
||||||
return ref
|
return ref
|
||||||
|
|
||||||
print("ERROR: Kein gültiger Ziel-Branch-Ref gefunden. Geprüft:", ", ".join(candidates))
|
return None
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
def changed_files():
|
def changed_files():
|
||||||
target = resolve_target_ref()
|
target = resolve_target_ref()
|
||||||
print(f"Vergleiche gegen Ziel-Ref: {target}")
|
|
||||||
out = run(f"git diff --name-only {target}...HEAD")
|
if target:
|
||||||
|
print(f"Vergleiche gegen Ziel-Ref: {target}")
|
||||||
|
out = run(f"git diff --name-only {target}...HEAD")
|
||||||
|
return [line.strip() for line in out.splitlines() if line.strip()]
|
||||||
|
|
||||||
|
if is_pull_request_build():
|
||||||
|
print("ERROR: Kein gültiger Ziel-Branch-Ref für PR-Build gefunden.")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
if git_ref_exists("HEAD~1"):
|
||||||
|
print("Kein Ziel-Branch-Ref gefunden, verwende HEAD~1 für Branch-Build.")
|
||||||
|
out = run("git diff --name-only HEAD~1..HEAD")
|
||||||
|
return [line.strip() for line in out.splitlines() if line.strip()]
|
||||||
|
|
||||||
|
print("Keine Vergleichsbasis gefunden, behandle alle versionierten Dateien als geändert.")
|
||||||
|
out = run("git ls-files")
|
||||||
return [line.strip() for line in out.splitlines() if line.strip()]
|
return [line.strip() for line in out.splitlines() if line.strip()]
|
||||||
|
|
||||||
def is_cpp_file(path: Path) -> bool:
|
def is_cpp_file(path: Path) -> bool:
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
hook test Di 4. Aug 00:08:29 CEST 2026
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
should fail
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
push-hook-test Di 4. Aug 00:11:58 CEST 2026
|
|
||||||
Reference in new issue
Block a user