Automatisieren Sie Ihre Git-Commit-Nachrichten mit ChatGPT

Das Erstellen aussagekräftiger und prägnanter Commit-Nachrichten ist ein wesentlicher Bestandteil eines guten Entwicklungsworkflows. Diese Nachrichten helfen dabei, Änderungen zu verfolgen, den Projektverlauf zu verstehen und mit Teammitgliedern zusammenzuarbeiten. Aber geben wir es zu – das Schreiben von Commit-Nachrichten kann manchmal eine banale Aufgabe sein. In diesem Artikel zeigen wir Ihnen, wie Sie ChatGPT von OpenAI verwenden, um automatisch Git-Commit-Nachrichten zu generieren, und wie Sie dieses Skript von jedem Verzeichnis auf Ihrem macOS-System aus ausführen.

Voraussetzungen

Um mitzumachen, benötigen Sie:

• Grundkenntnisse in Python.
• Git auf Ihrem Computer installiert.
• Ein Konto bei OpenAI und ein API-Schlüssel. Wenn Sie noch keinen API-Schlüssel haben, können Sie erfahren, wie Sie einen generieren, indem Sie dieser Anleitung zum Erstellen eines OpenAI-API-Schlüssels folgen.

Schritt 1: Einrichten der Umgebung

Installieren Sie zunächst das OpenAI-Python-Paket:

pip install openai

Als nächstes legen Sie Ihren OpenAI-API-Schlüssel als Umgebungsvariable fest:

export OPENAI_API_KEY='your_openai_api_key'

Schritt 2: Schreiben des Python-Skripts

Hier ist das Python-Skript generic_commit_message.py:

#!/usr/bin/env python3
import subprocess
from openai import OpenAI
import os

client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))

def get_git_diff():
    """Fetch the git changes."""
    result = subprocess.run(
        ["git", "diff", "--staged"], stdout=subprocess.PIPE, text=True
    )
    return result.stdout

def generate_commit_message(changes):
    """Use OpenAI API to generate a commit message."""
    response = client.chat.completions.create(
        model="gpt-4o-mini",
        messages=[
            {
                "role": "system",
                "content": "You are an assistant that generates helpful and concise git commit messages.",
            },
            {
                "role": "user",
                "content": f"Generate a Git commit message for the following changes, following the Git commit standards:\n\n{changes}",
            },
        ],
        max_tokens=350,  # Adjust as needed
        temperature=0.5,
    )
    return response.choices[0].message.content.strip()

def main():
    # Fetch the changes
    changes = get_git_diff()

    if not changes:
        print("No staged changes found.")
        return

    # Generate commit message
    commit_message = generate_commit_message(changes)
    print(f"Generated Commit Message: {commit_message}")

    # Optional: Automatically commit with the generated message
    # subprocess.run(["git", "commit", "-m", commit_message])

if __name__ == "__main__":
    main()

Speichern Sie dieses Skript in einer Datei mit dem Namen generic_commit_message.py.

Schritt 3: Das Skript ausführbar und zugänglich machen

Um das Skript von jedem Verzeichnis aus ausführbar und zugänglich zu machen, führen Sie die folgenden Schritte aus:

1. Machen Sie das Skript ausführbar:
   

   chmod +x /path/to/your/generate_commit_message.py
   

   Nach dem Login kopieren

2. Verschieben Sie das Skript in ein Verzeichnis in Ihrem PFAD:
   

   sudo mv /path/to/your/generate_commit_message.py /usr/local/bin/generate_commit_message
   

   Nach dem Login kopieren

3. Stellen Sie sicher, dass der OpenAI-API-Schlüssel in Ihrer Umgebung festgelegt ist:
   Fügen Sie die folgende Zeile zu Ihrem Shell-Profil hinzu (z. B. .bash_profile, .zshrc oder .bashrc):
   

   export OPENAI_API_KEY='your_openai_api_key'
   

   Nach dem Login kopieren

4. Laden Sie Ihr Profil neu:
   

   source ~/.bash_profile  # or source ~/.zshrc or source ~/.bashrc
   

   Nach dem Login kopieren

Schritt 4: Ausführen des Skripts

Stellen Sie sicher, dass Sie die Änderungen bereitgestellt haben, indem Sie Folgendes ausführen:

git add .

Führen Sie dann Ihr Skript aus einem beliebigen Verzeichnis aus:

generate_commit_message

Sie sollten eine generierte Commit-Nachricht in Ihrem Terminal sehen.

Abschluss

Durch die Nutzung von ChatGPT mit einem einfachen Python-Skript können Sie die Generierung aussagekräftiger Git-Commit-Nachrichten automatisieren. Dies spart nicht nur Zeit, sondern stellt auch sicher, dass Ihr Commit-Verlauf sowohl informativ als auch gut dokumentiert ist. Wenn Sie das Skript von jedem Verzeichnis auf macOS aus ausführbar machen, wird Ihr Arbeitsablauf weiter optimiert. Sie können das Skript jederzeit an Ihre Bedürfnisse anpassen oder seine Funktionalität erweitern. Viel Spaß beim Codieren!

Das obige ist der detaillierte Inhalt vonAutomatisieren Sie Ihre Git-Commit-Nachrichten mit ChatGPT. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!