* 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

* Fix(ci): Use project-specific API endpoints in youtrack-sync-kb.py (fixes 404)
This commit is contained in:
StefanMo
2025-11-08 10:19:38 +01:00
committed by GitHub
parent b35c4087a2
commit 4c600268d4
+92 -34
View File
@@ -11,9 +11,9 @@ Sicherheit:
- Bei HTTP-Fehlern werden Statuscode und gekürzte Antwort ausgegeben. - Bei HTTP-Fehlern werden Statuscode und gekürzte Antwort ausgegeben.
""" """
import argparse import argparse
import json
import os import os
import sys import sys
import json
import time import time
from pathlib import Path from pathlib import Path
@@ -29,6 +29,10 @@ SESSION.headers.update({
"Content-Type": "application/json", "Content-Type": "application/json",
}) })
# Globale Variablen, in main() gesetzt
PROJECT_ID = "MP" # Standardwert, wird in main() überschrieben
KB_ID = None # Knowledge-Base-ID des Projekts
KB_ROOT_ARTICLE_ID = None # ID des echten KB-Wurzelartikels (Container)
def yt_url(path: str) -> str: def yt_url(path: str) -> str:
base = os.environ.get("YT_URL", "").rstrip("/") base = os.environ.get("YT_URL", "").rstrip("/")
@@ -61,60 +65,89 @@ def http(method: str, url: str, **kw):
return r return r
return r return r
# *** KORRIGIERTE FUNKTION ***
def get_knowledge_bases(): def get_project_by_short_name(name: str):
url = yt_url("/api/knowledgeBases?fields=id,name") """Sucht die interne ID des Projekts anhand des Kürzels (z.B. 'MP')."""
url = yt_url(f"/api/projects?fields=id,shortName")
r = http("GET", url) r = http("GET", url)
if r.status_code != 200: if r.status_code != 200:
print(f"[YT] KB-Liste fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}") print(f"[YT] Projektliste fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1) sys.exit(1)
return r.json() for proj in r.json():
if proj.get("shortName") == name:
return proj
def find_kb_by_name(name: str):
for kb in get_knowledge_bases():
if kb.get("name") == name:
return kb
return None return None
# Neues Hilfs-API: Knowledge Base des Projekts abfragen
def find_article_in_kb_by_title(kb_id: str, title: str): def get_project_knowledge_base(project_id: str):
# Filter per search nicht stabil → hole paginiert und filtere clientseitig """Liest die Knowledge-Base eines Projekts, inkl. Root-Container-Artikel."""
url = yt_url(f"/api/articles?fields=id,title,knowledgeBase(id)&$top=1000") url = yt_url(f"/api/projects/{project_id}?fields=knowledgeBase(id,articlesCount,rootArticle(id,title))")
r = http("GET", url) r = http("GET", url)
if r.status_code != 200: if r.status_code != 200:
print(f"[YT] Artikel-Liste fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}") print(f"[YT] Projekt-Details fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1) sys.exit(1)
data = r.json()
kb = data.get("knowledgeBase")
if not kb:
return None
return kb
# *** KORRIGIERTE FUNKTION ***
def find_article_in_kb_by_title(title: str, parent_id: str | None = None):
"""Sucht einen Artikel anhand des Titels in der KB des Projekts.
Optional kann parent_id angegeben werden, um die Suche auf direkte Kinder eines Artikels einzuschränken.
"""
url = yt_url("/api/articles")
params = {
"query": f'title: "{title}"',
"fields": "id,title,knowledgeBase(id),parent(id)"
}
r = http("GET", url, params=params)
if r.status_code != 200:
print(f"[YT] Artikelsuche fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1)
for art in r.json(): for art in r.json():
if art.get("title") != title:
continue
kb = art.get("knowledgeBase") or {} kb = art.get("knowledgeBase") or {}
if kb.get("id") == kb_id and art.get("title") == title: if kb.get("id") != KB_ID:
continue
if parent_id:
parent = art.get("parent") or {}
if parent.get("id") != parent_id:
continue
return art return art
return None return None
# *** KORRIGIERTE FUNKTION ***
def create_article(kb_id: str, title: str, markdown: str): def create_article(title: str, markdown: str, parent_id: str = None):
"""Erstellt einen neuen Artikel in der Knowledge Base des Projekts."""
url = yt_url("/api/articles?fields=id,title") url = yt_url("/api/articles?fields=id,title")
payload = { payload = {
"title": title, "title": title,
"content": markdown, "content": markdown,
"knowledgeBase": {"id": kb_id}, "knowledgeBase": {"id": KB_ID}
# Sichtbarkeit: öffentlich/privat Standard-Einstellungen der KB werden übernommen
} }
if parent_id:
payload["parent"] = {"id": parent_id}
r = http("POST", url, data=json.dumps(payload)) r = http("POST", url, data=json.dumps(payload))
if r.status_code not in (200, 201): if r.status_code not in (200, 201):
print(f"[YT] Artikel erstellen fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}") print(f"[YT] Artikel erstellen fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1) sys.exit(1)
return r.json() return r.json()
# *** KORRIGIERTE FUNKTION ***
def update_article(article_id: str, markdown: str): def update_article(article_id: str, markdown: str):
"""Aktualisiert einen bestehenden Artikel in der Knowledge Base des Projekts."""
url = yt_url(f"/api/articles/{article_id}?fields=id") url = yt_url(f"/api/articles/{article_id}?fields=id")
payload = {"content": markdown} payload = {"content": markdown}
r = http("POST", url, data=json.dumps(payload)) # YouTrack erlaubt POST als Update
# YouTrack API verwendet POST für Updates an Artikeln
r = http("POST", url, data=json.dumps(payload))
if r.status_code not in (200, 201): 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]}") print(f"[YT] Artikel aktualisieren fehlgeschlagen: HTTP {r.status_code} {r.text[:400]}")
sys.exit(1) sys.exit(1)
@@ -138,6 +171,8 @@ def load_markdown(path: Path) -> str:
def main(): def main():
global PROJECT_ID, KB_ID, KB_ROOT_ARTICLE_ID # Zugriff auf globale Variablen
ap = argparse.ArgumentParser(description="Sync Dokka Markdown nach YouTrack KB") ap = argparse.ArgumentParser(description="Sync Dokka Markdown nach YouTrack KB")
ap.add_argument("--src", default="build/dokka/gfm", help="Quellverzeichnis (Markdown)") ap.add_argument("--src", default="build/dokka/gfm", help="Quellverzeichnis (Markdown)")
args = ap.parse_args() args = ap.parse_args()
@@ -155,25 +190,48 @@ def main():
print(f"[YT] Quelle nicht gefunden: {src} nichts zu tun.") print(f"[YT] Quelle nicht gefunden: {src} nichts zu tun.")
return 0 return 0
kb = find_kb_by_name(kb_root_title) # Projekt anhand des Kürzels ermitteln
if not kb: project_short_name = os.environ.get("YT_PROJECT", "MP").strip() or "MP"
print(f"[YT] Knowledge Base '{kb_root_title}' nicht gefunden. Bitte in YouTrack anlegen.") project = get_project_by_short_name(project_short_name)
if not project:
print(f"[YT] Projekt mit Kürzel '{project_short_name}' nicht gefunden.")
sys.exit(1) sys.exit(1)
kb_id = kb["id"] PROJECT_ID = project["id"]
print(f"[YT] Verwende KB: {kb_root_title} ({kb_id})") print(f"[YT] Arbeite im Projekt: {project_short_name} (ID: {PROJECT_ID})")
# Knowledge Base des Projekts abrufen
kb = get_project_knowledge_base(PROJECT_ID)
if not kb:
print("[YT] Dieses Projekt hat keine Knowledge Base. Bitte in YouTrack aktivieren/anlegen.")
sys.exit(1)
KB_ID = kb.get("id")
root_article = kb.get("rootArticle") or {}
KB_ROOT_ARTICLE_ID = root_article.get("id")
print(f"[YT] Verwende Knowledge Base: {KB_ID}; Root-Container: {KB_ROOT_ARTICLE_ID}")
# Root-Artikel (logische Wurzel unterhalb des KB-Root-Containers) finden/erstellen
kb_root = find_article_in_kb_by_title(kb_root_title, parent_id=KB_ROOT_ARTICLE_ID)
if not kb_root:
print(f"[YT] Root-Artikel '{kb_root_title}' nicht gefunden. Erstelle ihn unterhalb des KB-Root-Containers…")
kb_root = create_article(kb_root_title, f"# {kb_root_title}\n\nDieser Artikel dient als Wurzel für die automatische KDoc-Synchronisation.", parent_id=KB_ROOT_ARTICLE_ID)
print(f"[YT] Root-Artikel erstellt: {kb_root_title} (ID: {kb_root['id']})")
kb_root_id = kb_root["id"]
print(f"[YT] Verwende KB-Root: {kb_root_title} ({kb_root_id})")
count = 0 count = 0
for md in src.rglob("*.md"): for md in src.rglob("*.md"):
rel = md.relative_to(src) rel = md.relative_to(src)
title = build_title_from_path(rel, bc_root) title = build_title_from_path(rel, bc_root)
content = load_markdown(md) content = load_markdown(md)
# Optional: youtrack-spez. Front-Matter entfernen Dokka erzeugt keine
existing = find_article_in_kb_by_title(kb_id, title) existing = find_article_in_kb_by_title(title, parent_id=kb_root_id)
if existing: if existing:
update_article(existing["id"], content) update_article(existing["id"], content)
print(f"[YT] Aktualisiert: {title}") print(f"[YT] Aktualisiert: {title}")
else: else:
create_article(kb_id, title, content) # Erstelle Artikel als Kind des Root-Artikels
create_article(title, content, parent_id=kb_root_id)
print(f"[YT] Erstellt: {title}") print(f"[YT] Erstellt: {title}")
count += 1 count += 1