- New repo convention: /data/<service>/ for all persistent service data (gitignored) - New repo convention: /history/prompts/ (gitignored) + /history/summary/PROJECT_CONTEXT.md for agent session logging and compressed project context - git-templates/hooks/pre-commit: quality gate checking tests + docs on every commit - git-templates/docs/: USER.md, ADMIN.md, MAINTAINER.md templates (3 target groups) - git-templates/history/summary/PROJECT_CONTEXT.md: agent context template - prompts/history.prompt.md: /history prompt for logging sessions + updating summary - copilot-bootstrap.sh: creates all new folders, .gitignore entries, installs hook - deploy.sh + deploy.fish: deploy hooks, doc templates, history template - docs/ADMIN.md: new admin handbook for this project - docs/USER.md + docs/MAINTAINER.md: updated with new conventions - git-templates/.github/copilot-instructions.md: extended DoD + new conventions - README.md: updated structure overview + prompt table
96 lines
4.6 KiB
Bash
Executable file
96 lines
4.6 KiB
Bash
Executable file
#!/usr/bin/env sh
|
||
# pre-commit – Agent Quality Gate
|
||
#
|
||
# Prüft bei jeder Code-Änderung ob:
|
||
# 1. Tests erstellt oder aktualisiert wurden
|
||
# 2. Mindestens eine Zielgruppen-Dokumentation aktualisiert wurde
|
||
# 3. Alle 3 Dokumentations-Zielgruppen vorhanden sind (USER/ADMIN/MAINTAINER)
|
||
#
|
||
# Bypass (bewusst): git commit --no-verify
|
||
|
||
STAGED=$(git diff --cached --name-only --diff-filter=ACMR 2>/dev/null)
|
||
ERRORS=0
|
||
|
||
# Quellcode-Dateien (keine Tests, keine Konfiguration, keine Docs, keine Daten)
|
||
CODE_CHANGED=$(printf '%s\n' "$STAGED" \
|
||
| grep -E '\.(py|js|ts|mjs|cjs|go|java|rs|rb|php|c|cpp|h|hpp|cs|kt|swift|sh|bash)$' \
|
||
| grep -v -E '(test|spec|__tests__|_test)\.(py|js|ts|mjs|go|java|rs|rb|php|c|cpp|cs|kt|swift)$' \
|
||
| grep -v -E '^(docs/|\.github/|\.vscode/|data/|history/)' \
|
||
| grep -v -E '_test\.go$')
|
||
|
||
# Keine Code-Änderungen → Hook überspringen
|
||
if [ -z "$CODE_CHANGED" ]; then
|
||
exit 0
|
||
fi
|
||
|
||
# ── Check 1: Tests ────────────────────────────────────────────────────────────
|
||
TESTS_CHANGED=$(printf '%s\n' "$STAGED" \
|
||
| grep -E '(test|spec|__tests__|_test)\.(py|js|ts|mjs|go|java|rs|rb|php|c|cpp|cs|kt|swift)$|_test\.go$|test_.*\.py$')
|
||
|
||
if [ -z "$TESTS_CHANGED" ]; then
|
||
echo ""
|
||
echo "✗ AGENT QUALITY GATE [1/3]: Keine Test-Dateien geändert"
|
||
echo " Code-Änderungen ohne Test-Updates:"
|
||
printf '%s\n' "$CODE_CHANGED" | sed 's/^/ /'
|
||
echo ""
|
||
echo " → Tests fehlen oder nicht als STAGED markiert"
|
||
echo " → Copilot Chat: /write-tests | Bypass: git commit --no-verify"
|
||
ERRORS=$((ERRORS + 1))
|
||
fi
|
||
|
||
# ── Check 2: Dokumentation aktualisiert ───────────────────────────────────────
|
||
# Prüfen ob docs/ Verzeichnis überhaupt existiert
|
||
if [ -d "docs" ]; then
|
||
DOCS_CHANGED=$(printf '%s\n' "$STAGED" \
|
||
| grep -E '(^docs/USER\.md$|^docs/ADMIN\.md$|^docs/MAINTAINER\.md$|^README\.md$)')
|
||
|
||
if [ -z "$DOCS_CHANGED" ]; then
|
||
echo ""
|
||
echo "✗ AGENT QUALITY GATE [2/3]: Keine Dokumentation aktualisiert"
|
||
echo " Bei Code-Änderungen muss mindestens eine dieser Dateien angepasst werden:"
|
||
echo " docs/USER.md – Nutzer-Dokumentation"
|
||
echo " docs/ADMIN.md – Administrator-Dokumentation"
|
||
echo " docs/MAINTAINER.md – Entwickler/Maintainer-Dokumentation"
|
||
echo " README.md"
|
||
echo ""
|
||
echo " → Copilot Chat: Frage den Agent die relevante Doku zu aktualisieren"
|
||
echo " → Bypass: git commit --no-verify"
|
||
ERRORS=$((ERRORS + 1))
|
||
fi
|
||
fi
|
||
|
||
# ── Check 3: Vollständigkeit der 3 Zielgruppen ────────────────────────────────
|
||
# Nur prüfen wenn docs/ neu angelegt wird (noch nicht vollständig) oder ein
|
||
# neues Feature ein neues docs/-File staged hat.
|
||
DOCS_DIR_STAGED=$(printf '%s\n' "$STAGED" | grep -E '^docs/' | head -1)
|
||
|
||
if [ -n "$DOCS_DIR_STAGED" ] && [ -d "docs" ]; then
|
||
MISSING=""
|
||
[ ! -f "docs/USER.md" ] && MISSING="${MISSING}\n docs/USER.md (fehlt – für Endnutzer)"
|
||
[ ! -f "docs/ADMIN.md" ] && MISSING="${MISSING}\n docs/ADMIN.md (fehlt – für Administratoren)"
|
||
[ ! -f "docs/MAINTAINER.md" ] && MISSING="${MISSING}\n docs/MAINTAINER.md (fehlt – für Entwickler)"
|
||
|
||
if [ -n "$MISSING" ]; then
|
||
echo ""
|
||
echo "✗ AGENT QUALITY GATE [3/3]: Fehlende Zielgruppen-Dokumentation"
|
||
printf " Nicht vorhanden:%b\n" "$MISSING"
|
||
echo ""
|
||
echo " Alle 3 Zielgruppen-Dokumente müssen existieren."
|
||
echo " Templates: docs/USER.md, docs/ADMIN.md, docs/MAINTAINER.md"
|
||
echo " Bypass: git commit --no-verify"
|
||
ERRORS=$((ERRORS + 1))
|
||
fi
|
||
fi
|
||
|
||
# ── Ergebnis ──────────────────────────────────────────────────────────────────
|
||
if [ "$ERRORS" -gt 0 ]; then
|
||
echo ""
|
||
echo "══════════════════════════════════════════════════════════"
|
||
echo " $ERRORS von 3 Quality Gate(s) nicht bestanden."
|
||
echo " Behebe die Probleme ODER: git commit --no-verify"
|
||
echo "══════════════════════════════════════════════════════════"
|
||
echo ""
|
||
exit 1
|
||
fi
|
||
|
||
exit 0
|