Fix: Test-Commit für VCS-Integration (MP-8) (#15)

* MP-8 OTHER Implementiere JWT-Authentifizierungs-Filter im Gateway

* Fix(ci): Update upload-artifact action to v4

* Fix(ci): Add start command for Keycloak and failure logs

* Fix(ci): Remove invalid 'command' property from Keycloak service

* Fix(ci): Use KC_DEV_MODE env var to start Keycloak

* Fix(ci): Keycloak service was removed from GitHub Actions services and replaced with a manual docker run step that starts Keycloak with the start-dev command.

* dev(ci): vereinheitliche Keycloak auf 26.4.2; aktiviere Health im CI (MP-8)

* Fix(ci): Stabilize Keycloak startup in integration tests via matrix

- Add `dev-file` Keycloak variant to matrix for stability fallback.
- Improve wait logic and health checks for Keycloak and Postgres.
- Unify Keycloak version to 26.4.2 across codebase.
- Add log dumps on failure.

* Fix(ci): Die betroffene Datei docs/Visionen-Ideen/Infrastruktur-Strategie_DSGVO-Konformität.md endet aktuell mit genau einer leeren Zeile (Zeile 87). Das entspricht der Regel MD047 („Files should end with a single newline character“). Damit ist deine Korrektur korrekt.

* Fix(ci): Repository-wide auto-fix for Markdown files was implemented with a GitHub Actions workflow and a local helper script. EditorConfig and markdownlint ignore files were added to ensure consistent formatting. Instructions for using the auto-fix both via GitHub Actions and locally were provided.

* fix(gradle): build.gradle.kts jsBrowser testTask disabled

* fix(gradle): build.gradle.kts jsBrowser testTask disabled

* Fix(ci): Stabilize integration tests with Keycloak matrix build (MP-8)

Introduces a matrix strategy (`keycloak_db: [postgres, dev-file]`)
in the integration-tests workflow to mitigate flaky Keycloak starts
when using the Postgres service container.

- Adds a `dev-file` Keycloak variant for stability fallback.
- Improves wait logic and health checks for Keycloak/Postgres.
- Unifies Keycloak version to 26.4.2 across codebase (Dockerfile, Compose,
  ADR, README, tests).
- Adds log dumps on failure in CI.
- Ensures `KC_HEALTH_ENABLED=true` is set.
- Updates related documentation (README, Schlachtplan).
- Includes broader Docker SSoT cleanup (versions.toml as source,
  script updates, env file cleanup, validator hardening).

This resolves recurring CI failures related to Keycloak startup and
ensures required checks for PRs (#15) are reliable, while also
improving overall Docker build consistency.

* feat(docs, ci): Implement YouTrack SSoT strategy with Dokka sync (MP-8)

- Add Dokka multi-module Gradle configuration and KDoc style guide.
- Add GitHub Actions workflow (docs-kdoc-sync.yml) and Python script
  (youtrack-sync-kb.py) to sync Dokka GFM output to YouTrack KB.
- Extend front-matter schema (bc, doc_type) and update relevant pages/stubs.
- Adapt CI scripts (validate-frontmatter, check-docs-drift, ci-docs link ignore).
- Update README.md to reference YouTrack KB.

* feat(docs, ci): Implement YouTrack SSoT strategy with Dokka sync (MP-8)

- Add Dokka multi-module Gradle configuration and KDoc style guide.
- Add GitHub Actions workflow (docs-kdoc-sync.yml) and Python script
  (youtrack-sync-kb.py) to sync Dokka GFM output to YouTrack KB.
- Extend front-matter schema (bc, doc_type) and update relevant pages/stubs.
- Adapt CI scripts (validate-frontmatter, check-docs-drift, ci-docs link ignore).
- Update README.md to reference YouTrack KB.

* Fix(ci): Replace OpenAPI validator with Spectral

Replaces the deprecated 'char0n/swagger-editor-validate' action,
which failed due to sandbox issues in GitHub Actions, with the
modern '@stoplight/spectral-cli'.

This ensures robust OpenAPI specification validation without
requiring a headless browser environment. The 'generate-api-docs'
job now depends on the successful completion of the Spectral validation.

Part of resolving CI failures for PR #15 (MP-8).

* Fix(ci): Specify spectral:oas ruleset for OpenAPI validation (MP-8)

* Fix(ci): Remove explicit ruleset argument for Spectral validation (MP-8)

* Fix(ci): Added a .spectral.yaml file to fix Spectral linting errors. Corrected markdown lint issues in two documentation files. Updated README.md with a new guidelines section to fix link validation errors.

* Fix(ci): Markdownlint errors were fixed by adding required blank lines. The Guidelines Validation error was resolved by updating the README.md link. The API Documentation Generator workflow was stabilized by updating paths, tasks, and validation steps.

* Fix(ci): Alle vier fehlerhaften GitHub-Action-Prüfungen wurden behoben. Fehler in der OpenAPI-Spezifikation, Probleme mit der Markdown-Linting-Analyse und Validierungsfehler bei Querverweisen wurden korrigiert. Die README.md enthält nun alle erforderlichen Links zu den Richtlinien.

* Fix(ci): Markdown linting errors in docs/api/README.md were fixed by specifying languages in fenced code blocks. OpenAPI specification errors in documentation.yaml were resolved by correcting example property types to strings. Cross-reference validation errors in README.md were fixed by adding the missing link to project-standards/coding-standards.md.

* Fix(ci): Duplicate heading errors in docs/api/members-api.md were fixed. Cross-reference validation errors for docker-architecture.md were resolved. All originally reported issues passed validation successfully.

* Fix(ci): The markdown heading levels in docs/api/members-api.md were corrected from h5 to h4 to fix linting errors. The missing cross-reference link from technology-guides/docker/docker-development.md to docker-overview.md was added. These fixes resolved the original validation and linting errors causing the process to fail.

* Fix(ci): Duplicate heading warnings in docs/api/members-api.md were resolved. Cross-reference validation for docker-development.md to docker-architecture.md was fixed. A new unrelated warning about docker-production.md was identified but not addressed.

* refactor(ci,docs): Simplify CI pipeline and migrate docs to YouTrack SSoT

BREAKING CHANGE: Documentation structure radically simplified

- Consolidate 9 GitHub Actions workflows into 1 main pipeline (ci-main.yml)
- Remove redundant workflows: ci-docs, markdownlint-autofix, guidelines-validation, api-docs
- Delete documentation migrated to YouTrack: api/, BCs/, Visionen-Ideen/, reference/, now/, overview/
- Keep only ADRs, C4 diagrams, and essential dev guides in repo
- Update README.md with YouTrack KB links
- Create new docs/README.md as documentation gateway
- Relax markdown-lint config for pragmatic developer experience

Kept workflows:
- ssot-guard.yml (Docker SSoT validation)
- docs-kdoc-sync.yml (KDoc → YouTrack sync)
- integration-tests.yml (Integration tests)
- deploy-proxmox.yml (Deployment)
- youtrack-sync.yml (YouTrack integration)

Related: MP-DOCS-001

* refactor(ci,docs): Simplify CI pipeline and migrate docs to YouTrack SSoT

BREAKING CHANGE: Documentation structure radically simplified

- Consolidate 9 GitHub Actions workflows into 1 main pipeline (ci-main.yml)
- Remove redundant workflows: ci-docs, markdownlint-autofix, guidelines-validation, api-docs
- Delete documentation migrated to YouTrack: api/, BCs/, Visionen-Ideen/, reference/, now/, overview/
- Keep only ADRs, C4 diagrams, and essential dev guides in repo
- Update README.md with YouTrack KB links
- Create new docs/README.md as documentation gateway
- Relax markdown-lint config for pragmatic developer experience

Kept workflows:
- ssot-guard.yml (Docker SSoT validation)
- docs-kdoc-sync.yml (KDoc → YouTrack sync)
- integration-tests.yml (Integration tests)
- deploy-proxmox.yml (Deployment)
- youtrack-sync.yml (YouTrack integration)

Related: MP-DOCS-001

* refactor(ci,docs): README.md und einige andere Dokumentationen überarbeitet.
ports-and-urls.md hinzugefügt.
Related: MP-DOCS-001

* refactor(ci,docs): Die Markdownlint-Fehler in README.md und docs/README.md wurden behoben, indem die Überschriftenebenen angepasst, überflüssige Satzzeichen am Ende entfernt und die notwendigen Leerzeilen um Überschriften, Listen, Tabellen und Codeblöcke eingefügt wurden. Das problematische Leerzeichen am Ende in docs/README.md wurde ebenfalls entfernt. Die Dateien entsprechen nun den vorgegebenen Markdownlint-Regeln und sollten die CI-Validierung bestehen.
Related: MP-DOCS-001

* refactor(ci,docs): Docker guideline cross-references were fixed and normalized to lowercase labels. Validation scripts confirmed zero cross-reference warnings and consistent metadata. Documentation was updated with a changelog and enhanced README navigation.
Related: MP-DOCS-001

* refactor(ci,docs): Docker guideline cross-references were fixed and normalized to lowercase labels. Validation scripts confirmed zero cross-reference warnings and consistent metadata. Documentation was updated with a changelog and enhanced README navigation.
Related: MP-DOCS-001

* refactor(ci,docs): Dead links in docs/architecture/adr were fixed by updating URLs to stable sources and adding an ignore pattern for a placeholder link. Specific ADR files had their broken links replaced with valid ones. The markdown-link-check GitHub Action is expected to pass with zero dead links now.
Related: MP-DOCS-001

* refactor(ci,docs): Links in ADR checked
Related: MP-DOCS-001

* refactor(ci,docs): Links in ADR checked
Related: MP-DOCS-001

* refactor(ci,docs): Markdown Regeln ausgebessert
Related: MP-DOCS-001

* refactor(ci,docs): Markdown Regeln ausgebessert
Related: MP-DOCS-001

* refactor(ci,docs): Markdown Regeln ausgebessert
Related: MP-DOCS-001

* Chore: Rerun CI checks with updated branch protection rules
This commit is contained in:
StefanMo
2025-11-07 12:26:33 +01:00
committed by GitHub
parent 6850cd92d4
commit b35c4087a2
129 changed files with 4016 additions and 7131 deletions
+13
View File
@@ -27,4 +27,17 @@ if ls docs/architecture/c4/*.puml 2>/dev/null | grep -E -v '-de\.puml$' >/dev/nu
err=1
fi
# ADR-Stubs: max. 40 Zeilen und YouTrack-Link Pflicht, wenn als Stub gekennzeichnet
for f in $(grep -RIl "^doc_type: adr-link" docs/architecture/adr 2>/dev/null || true); do
lines=$(wc -l < "$f" | tr -d ' ')
if [ "${lines}" -gt 40 ]; then
echo "[DRIFT] ADR-Stub überschreitet 40 Zeilen: $f (${lines})"
err=1
fi
if ! grep -Eiq "https?://[^ ]*youtrack" "$f"; then
echo "[DRIFT] ADR-Stub ohne YouTrack-Link: $f"
err=1
fi
done
exit $err
+58
View File
@@ -0,0 +1,58 @@
#!/usr/bin/env bash
set -euo pipefail
# Markdown auto-fix helper
# - Runs markdownlint in --fix mode over all Markdown files
# - Normalizes final newline at EOF (MD047)
# - Respects repo config (.markdownlint.yaml, .markdownlintignore)
ROOT_DIR=$(git rev-parse --show-toplevel 2>/dev/null || pwd)
cd "$ROOT_DIR"
# Ensure dependencies are available (prefer locally installed first)
if ! command -v markdownlint >/dev/null 2>&1; then
if command -v npm >/dev/null 2>&1; then
echo "[INFO] Installing markdownlint-cli globally (requires npm) ..."
npm i -g markdownlint-cli >/dev/null 2>&1 || true
fi
fi
# As fallback, use npx if markdownlint is still not found
RUN_MDLINT="markdownlint"
if ! command -v markdownlint >/dev/null 2>&1; then
if command -v npx >/dev/null 2>&1; then
RUN_MDLINT="npx -y markdownlint-cli"
else
echo "[ERROR] markdownlint-cli not found and npm/npx unavailable. Please install Node.js (>= 18) first." >&2
exit 1
fi
fi
echo "[INFO] Running markdownlint --fix over all Markdown files ..."
# shellcheck disable=SC2086
$RUN_MDLINT \
--fix \
--config .markdownlint.yaml \
--ignore-path .markdownlintignore \
"**/*.md" || true
# Normalize EOF: ensure exactly one trailing newline (MD047) for all tracked Markdown files
# Uses Perl to replace any trailing whitespace/newlines with a single newline.
if command -v perl >/dev/null 2>&1; then
echo "[INFO] Normalizing end-of-file newlines (MD047) ..."
git ls-files "*.md" | while read -r f; do
perl -0777 -pe 's/\s*\z/\n/' "$f" > "$f.tmp.$RANDOM" && mv "$f.tmp."* "$f"
done
else
echo "[WARN] Perl not found; skipping explicit MD047 normalization. EditorConfig may cover this on save."
fi
# Show summary of changes
if ! git diff --quiet; then
echo "[INFO] Changes made by auto-fix:";
git --no-pager diff --stat
echo "[HINT] Review and commit changes:";
echo " git add -A && git commit -m \"chore(docs): markdown auto-fix\""
else
echo "[INFO] No changes required. Markdown files already conform to rules."
fi
+3
View File
@@ -15,6 +15,9 @@ with open(SCHEMA_PATH, encoding='utf-8') as f:
errors = 0
for path in glob('docs/**/*.md', recursive=True):
# ADRs und ggf. generierte Inhalte vorerst ausnehmen (separater Rollout für FM)
if path.startswith('docs/architecture/adr/'):
continue
# Skip generated or non-content files if any (none by default)
with open(path, 'r', encoding='utf-8') as fh:
content = fh.read()
+8 -2
View File
@@ -123,7 +123,12 @@ validate_cross_references() {
}
while IFS= read -r guideline; do
guideline_file="$GUIDELINES_DIR/$guideline"
# Special handling for README.md which is at project root
if [[ "$guideline" == "README.md" ]]; then
guideline_file="$PROJECT_ROOT/README.md"
else
guideline_file="$GUIDELINES_DIR/$guideline"
fi
# Prüfe ob Guideline-Datei existiert
if [[ ! -f "$guideline_file" ]]; then
@@ -168,7 +173,8 @@ validate_cross_references() {
# Prüfe ob der Link tatsächlich im Markdown existiert (nur im vollständigen Modus)
if [[ "$QUICK_MODE" = false ]]; then
ref_basename=$(basename "$ref" .md)
if ! grep -q "\[$ref_basename\]" "$guideline_file" && ! grep -q "($ref)" "$guideline_file"; then
# Check for link with basename in brackets OR reference path (with or without directory) in parentheses
if ! grep -q "\[$ref_basename\]" "$guideline_file" && ! grep -qE "\([^)]*$ref\)" "$guideline_file"; then
log_warning "'$guideline' sollte '$ref' referenzieren, aber Link fehlt im Markdown"
((WARNINGS++))
fi
+185
View File
@@ -0,0 +1,185 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Spiegelt Markdown-Dateien (z. B. aus build/dokka/gfm) in eine YouTrack Knowledge Base.
- Verwendet Umgebungsvariablen YT_URL und YT_TOKEN
- Erwartet den KB-Root-Titel in KB_ROOT_TITLE (z. B. "API & Entwicklerdoku")
- Optional: KB_BC_ROOT (Unterordnername, z. B. "BCs") wird aktuell nur als Titelpräfix genutzt
Sicherheit:
- Tokens werden niemals geloggt.
- Bei HTTP-Fehlern werden Statuscode und gekürzte Antwort ausgegeben.
"""
import argparse
import os
import sys
import json
import time
from pathlib import Path
try:
import requests
except ImportError: # pragma: no cover
print("[YT] requests fehlt. Bitte 'pip install requests' ausführen.")
sys.exit(2)
SESSION = requests.Session()
SESSION.headers.update({
"Accept": "application/json",
"Content-Type": "application/json",
})
def yt_url(path: str) -> str:
base = os.environ.get("YT_URL", "").rstrip("/")
if not base:
print("[YT] YT_URL fehlt in Env.")
sys.exit(2)
if not path.startswith("/"):
path = "/" + path
return base + path
def set_auth():
token = os.environ.get("YT_TOKEN")
if not token:
print("[YT] YT_TOKEN fehlt in Env.")
sys.exit(2)
# Bearer Token
SESSION.headers["Authorization"] = f"Bearer {token}"
def http(method: str, url: str, **kw):
# Einfaches Retry bei 429/5xx
for attempt in range(5):
r = SESSION.request(method, url, timeout=30, **kw)
if r.status_code in (429, 500, 502, 503, 504):
wait = (attempt + 1) * 1.5
print(f"[YT] {r.status_code} → Retry in {wait:.1f}s…")
time.sleep(wait)
continue
return r
return r
def get_knowledge_bases():
url = yt_url("/api/knowledgeBases?fields=id,name")
r = http("GET", url)
if r.status_code != 200:
print(f"[YT] KB-Liste fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1)
return r.json()
def find_kb_by_name(name: str):
for kb in get_knowledge_bases():
if kb.get("name") == name:
return kb
return None
def find_article_in_kb_by_title(kb_id: str, title: str):
# Filter per search nicht stabil → hole paginiert und filtere clientseitig
url = yt_url(f"/api/articles?fields=id,title,knowledgeBase(id)&$top=1000")
r = http("GET", url)
if r.status_code != 200:
print(f"[YT] Artikel-Liste fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1)
for art in r.json():
kb = art.get("knowledgeBase") or {}
if kb.get("id") == kb_id and art.get("title") == title:
return art
return None
def create_article(kb_id: str, title: str, markdown: str):
url = yt_url("/api/articles?fields=id,title")
payload = {
"title": title,
"content": markdown,
"knowledgeBase": {"id": kb_id},
# Sichtbarkeit: öffentlich/privat Standard-Einstellungen der KB werden übernommen
}
r = http("POST", url, data=json.dumps(payload))
if r.status_code not in (200, 201):
print(f"[YT] Artikel erstellen fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1)
return r.json()
def update_article(article_id: str, markdown: str):
url = yt_url(f"/api/articles/{article_id}?fields=id")
payload = {"content": markdown}
r = http("POST", url, data=json.dumps(payload)) # YouTrack erlaubt POST als Update
if r.status_code not in (200, 201):
# Fallback PATCH
r = http("PATCH", url, data=json.dumps(payload))
if r.status_code not in (200, 204):
print(f"[YT] Artikel aktualisieren fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1)
def build_title_from_path(rel_path: Path, bc_root: str | None) -> str:
# Beispiel: infrastructure/gateway/index.md → "infrastructure / gateway / index.md"
parts = list(rel_path.parts)
title = " / ".join(parts)
if bc_root:
title = f"{bc_root} / {title}"
return title
def load_markdown(path: Path) -> str:
try:
text = path.read_text(encoding="utf-8")
except Exception as e:
print(f"[YT] Kann Datei nicht lesen: {path}: {e}")
sys.exit(1)
return text
def main():
ap = argparse.ArgumentParser(description="Sync Dokka Markdown nach YouTrack KB")
ap.add_argument("--src", default="build/dokka/gfm", help="Quellverzeichnis (Markdown)")
args = ap.parse_args()
kb_root_title = os.environ.get("KB_ROOT_TITLE")
bc_root = os.environ.get("KB_BC_ROOT")
if not kb_root_title:
print("[YT] KB_ROOT_TITLE fehlt in Env.")
sys.exit(2)
set_auth()
src = Path(args.src)
if not src.exists():
print(f"[YT] Quelle nicht gefunden: {src} nichts zu tun.")
return 0
kb = find_kb_by_name(kb_root_title)
if not kb:
print(f"[YT] Knowledge Base '{kb_root_title}' nicht gefunden. Bitte in YouTrack anlegen.")
sys.exit(1)
kb_id = kb["id"]
print(f"[YT] Verwende KB: {kb_root_title} ({kb_id})")
count = 0
for md in src.rglob("*.md"):
rel = md.relative_to(src)
title = build_title_from_path(rel, bc_root)
content = load_markdown(md)
# Optional: youtrack-spez. Front-Matter entfernen Dokka erzeugt keine
existing = find_article_in_kb_by_title(kb_id, title)
if existing:
update_article(existing["id"], content)
print(f"[YT] Aktualisiert: {title}")
else:
create_article(kb_id, title, content)
print(f"[YT] Erstellt: {title}")
count += 1
print(f"[YT] Fertig. {count} Artikel synchronisiert.")
return 0
if __name__ == "__main__":
sys.exit(main())