Git-Dokumentation KI-gestützt automatisieren

|
Weißer Text auf blauem Hintergrund: Git-Dokumentation automatisieren

Eine gute Dokumentation deines Codes ist wichtig ... kostet aber viel Zeit. Und: Es macht keinen Spaß. Zum Glück gibt es einen Weg, die Dokumentationsarbeit auf ein Minimum zu reduzieren. Mit dem AI-Hosting von mittwald und dem Open-Source-Tool cmai (AI Commit Message Generator) kannst du dir professionelle Commit Messages automatisch generieren lassen. Wie das funktioniert, erfährst du hier. 

Eine gute Doku ist viel wert 

Jede Änderung deines Codes wird in Git als Commit bezeichnet. Dieser Commit muss mit einer Commit Message dokumentiert werden. Je besser die Änderung dokumentiert wird, umso einfacher ist sie später wieder auffind- und nachvollziehbar. Dein Zukunfts-Ich freut sich also über eine gute Doku. Nur, im Arbeitsalltag fehlt oft die Zeit für ausführliche Commit Messages. 

Die Lösung: Automatisierte Commit Messages mit KI 

Hier kommt cmai ins Spiel. Das Tool schaut sich die Änderungen an und erkennt, welche Zeilen dazu gekommen sind, welche sich geändert haben und welche gelöscht wurden.  Anschließend generiert cmai aus dieser Information eine Commit Message.  

Der Vorteil: Deine Commit Messages sind so vollständig und entsprechen immer deinem vordefinierten Schema. Standardmäßig werden sie entsprechend der Conventional Commits Spec generiert. Durch Ändern des Prompts kannst du das Schema nach deinen Wünschen anpassen. 

Jetzt aber mal reinfolgen!

Abonniere Tipps für CMS und Dev-Tools, Hosting Hacks und den ein oder anderen Gag. Unsere schnellen Takes für dich per E-Mail.

Wie dürfen wir dich ansprechen?

Technische Umsetzung: AI-Hosting x cmai

Praktisch an cmai: Du kannst alle KI-Modelle anbinden.  

Die Einrichtung ist simpel:

  1. AI-Modell im mStudio anlegen
     Leg dir im mStudio ein AI-Modell an und erstelle einen API-Key.
  2. Installation
    curl -fsSL https://github.com/mittwald/ai-developer-tools/raw/refs/heads/main/install-git-commit-ai.sh | bash 

So installierst du cmai

Screenshot aus dem Installationsprozess
Screenshot aus dem Installationsprozess

Der Vorteil: Alles in-house

Statt deine Code-Diffs an externe Anbieter zu senden, läuft jetzt alles über deine eigene AI-Hosting-Infrastruktur bei mittwald. Deine Code-Änderungen bleiben in deinem Hoheitsbereich – ein wichtiger Punkt für Agenturen und Unternehmen, die auf Datensicherheit und DSGVO-Konformität achten müssen. Alles läuft in unserer eigenen Infrastruktur in unserem Rechenzentrum in Deutschland, ganz ohne externe Dienstleister oder US-Firmen. Stichwort: Digitale Souveränität. 

Fazit: Mehr Zeit für das Wesentliche 

Automatisierte Commit Messages sind nicht nur eine Spielerei – sie verbessern nachhaltig die Qualität deiner Code-Dokumentation. Mit der Kombination aus dem AI-Hosting und cmai hast du eine professionelle Lösung, die lokal auf deinem Rechner läuft und deine Daten nicht nach außen trägt. 

Tipp!

Im AI Hosting kannst du KI-Modelle 100 % digital souverän und DSGVO-konform betreiben. Keine Speicherung von Trainingsdaten. Gehostet in unserem Rechenzentrum in Deutschland. Probier's aus!

Ähnliche Artikel:

Mit AI-Hosting barrierefreie Alt-Texte automatisieren – Marketing Factory baut TYPO3-Extension

Eine Extension mit echtem Impact: Ingo Schmitt ist Geschäftsführer der Agentur Marketing Factory und sprach mit mir über seine Extension ai_filemetdata. Mit dieser können...

Datenschutzfreundliche Webanalyse mit Umami Analytics, n8n, Container- und AI-Hosting

How to für DSGVO-konformes Tracking inkl. automatisierten Reports. Umgesetzt mit Umami Analytics und n8n.