Automatisierte Erstellung von GitHub Release Notes durch KI-Vergleich - n8n-Workflow

• Softwareentwicklungsteams


• DevOps-Ingenieure, die eine Automatisierung für Releases suchen


• Technische Redakteure, die Entwürfe für automatisierte Dokumentationen benötigen


• Anwender, die benutzerdefinierte n8n-Workflow-Lösungen bereitstellen


• Alle, die schnell akkurate, kategorisierte Changelogs erstellen möchten.

Dieser anspruchsvolle n8n-Workflow löst das kritische, aber oft manuelle Problem der Zusammenstellung präziser Changelogs nach einem Software-Release. Durch die Nutzung der GitHub API und die Integration fortschrittlicher großer Sprachmodelle (über den OpenRouter/LangChain n8n-Knoten) verfolgt diese n8n-Vorlage automatisch die Unterschiede zwischen zwei veröffentlichten Git-Tags. Sobald ein neues Release-Ereignis vom n8n-Trigger erkannt wird, ruft der Workflow effizient detaillierte Commits und geänderte Dateien ab. Diese Rohdaten werden einer Reihe von KI-Agenten zugeführt, die die Änderungen in Funktionen (Features), Fehlerbehebungen (Bug fixes) und Verbesserungen kategorisieren. Das Endergebnis sind saubere, SEO-freundliche Release Notes im Markdown-Format, die zur sofortigen Veröffentlichung bereit sind und die Dokumentationspipeline für jedes auf n8n basierende Entwicklungsteam drastisch beschleunigen.

1. Auslösen des n8n-Workflows: Die Automatisierung startet mit dem Github Trigger n8n-Trigger, der so konfiguriert ist, dass er spezifisch auf neue release-Ereignisse im angegebenen GitHub-Repository lauscht.


2. Ermitteln der Release-Details: Eine Kombination aus Code- und Set-n8n-Knotenschritten (Fetch the latest release body und Set Repo & Owner) extrahiert den Repository-Owner, den Namen und den aktuellen Tag aus der Webhook-Nutzlast und standardisiert die Variablen für nachgelagerte Knoten.


3. Abrufen der Vergleichs-Tags: Ein nachfolgender Get the last two releases GitHub n8n-Knoten ruft die jüngste Release-Historie ab. Der Get the last two release tags Code n8n-Knoten führt dann eine entscheidende Logik aus, um den currentTag und den previousTag, die für den Vergleich benötigt werden, korrekt zu identifizieren.


4. Ausführen des Diffs: Ein HTTP Request n8n-Knoten ruft den wichtigen GitHub Compare API-Endpunkt auf (unter Verwendung der URL .../compare/{{previousTag}}...{{currentTag}}). Diese API-Anfrage ruft den vollständigen detaillierten Diff ab, einschließlich Commit-Nachrichten und Datei-Patches.


5. Datenvorverarbeitung: Der Confirm diff Code n8n-Knoten verarbeitet diese komplexe JSON-Diff-Nutzlast. Er vereinfacht die Commit- und Datei-Daten, ermittelt, ob tatsächliche Änderungen stattgefunden haben (hasChanges), und erstellt eine saubere JSON-Struktur, die für die KI-Verarbeitung optimiert ist.


6. KI-Zusammenfassung und -Generierung: Der bereinigte Diff wird an die KI-Stufen weitergegeben:

1. n8n-Vorlage importieren: Kopieren Sie das bereitgestellte JSON und importieren Sie es in Ihre n8n-Instanz über die Funktion 'Neu' -> 'Aus JSON importieren'.


2. GitHub-Zugangsdaten einrichten: Sie müssen eine GitHub OAuth2-Anmeldeinformation konfigurieren. Diese benötigen Leseberechtigung für Ihre Repository-Releases und müssen mit dem Github Trigger, dem Get the last two releases GitHub n8n-Knoten und dem Fetch release details from last two releases HTTP Request n8n-Knoten verknüpft werden.


3. OpenRouter-Zugangsdaten einrichten: Konfigurieren Sie ein OpenRouter API-Schlüssel-Credential und verknüpfen Sie es mit den Instanzen der n8n-Knoten OpenRouter Chat Model und OpenRouter Chat Model1, um sicherzustellen, dass die KI die Anfragen verarbeiten kann.


4. Trigger konfigurieren: Geben Sie im Github Trigger n8n-Trigger den korrekten Repository-Owner und den Repository-Namen für das zu automatisierende Projekt an.


5. Aktivieren und Testen: Speichern Sie den n8n-Workflow, aktivieren Sie ihn und lösen Sie ein neues Release in Ihrem Ziel-GitHub-Repository aus, um die Ende-zu-Ende-Automatisierung zu testen.

Github Trigger (n8n trigger): Richtet einen Webhook ein, um den n8n-Workflow gezielt zu starten, sobald ein neues release-Ereignis im konfigurierten GitHub-Repository veröffentlicht wird.
Get the last two releases (GitHub n8n node): Führt eine release: getAll-Operation durch, beschränkt auf die beiden neuesten Releases, was für die Festlegung des Vergleichsfensters unerlässlich ist.
Get the last two release tags (Code n8n node): Enthält benutzerdefinierte JavaScript-Logik, um den currentTag und den previousTag aus den abgerufenen Releases sicher zu extrahieren und zu validieren.
Fetch release details from last two releases (HTTP Request n8n node): Führt den kritischen API-Aufruf an den Compare-Endpunkt von GitHub durch, wobei dynamische Ausdrücke verwendet werden, um den Owner, das Repo und die beiden Vergleichs-Tags einzubeziehen, um den vollständigen Code-Diff abzurufen.
Confirm diff (Code n8n node): Bereinigt und vereinfacht die große GitHub-Diff-Nutzlast, strukturiert die Commit- und Datei Änderungsdaten neu in ein Format, das vom nachfolgenden KI LangChain n8n-Knoten optimal verarbeitet werden kann.
Summarize release differences (LangChain Agent n8n node): Nutzt einen aussagekräftigen Prompt und die OpenRouter-Verbindung, um die strukturierten Diff-Daten zu analysieren und technische Änderungen in benutzerfreundliche Zusammenfassungsabschnitte zu gruppieren (z. B. Neue Funktionen, Fehlerbehebungen).

• Generate latest release notes (LangChain Agent n8n node): Der abschließende KI n8n-Knoten, zuständig für die Erstellung der vollständigen, korrekt formatierten Markdown-Release Notes unter Verwendung der kategorisierten Zusammenfassung und der spezifischen Versions-Tags.