Automatisez vos messages de validation Git avec ChatGPT

Créer des messages de validation significatifs et concis est un élément essentiel d'un bon flux de travail de développement. Ces messages aident à suivre les modifications, à comprendre l'historique du projet et à collaborer avec les membres de l'équipe. Mais admettons-le : écrire des messages de validation peut parfois être une tâche banale. Dans cet article, nous vous expliquerons comment utiliser ChatGPT d'OpenAI pour générer automatiquement des messages de validation Git et comment exécuter ce script à partir de n'importe quel répertoire de votre système macOS.

Conditions préalables

Pour suivre, vous aurez besoin de :

• Connaissance de base de Python.
• Git installé sur votre machine.
• Un compte sur OpenAI et une clé API. Si vous ne disposez pas déjà d'une clé API, vous pouvez apprendre à en générer une en suivant ce guide sur la création d'une clé API OpenAI.

Étape 1 : Configuration de l'environnement

Tout d'abord, installez le package openai Python :

pip install openai

Ensuite, définissez votre clé API OpenAI comme variable d'environnement :

export OPENAI_API_KEY='your_openai_api_key'

Étape 2 : écriture du script Python

Voici le script Python generate_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()

Enregistrez ce script dans un fichier nommé generate_commit_message.py.

Étape 3 : Rendre le script exécutable et accessible

Pour rendre le script exécutable et accessible depuis n'importe quel répertoire, suivez ces étapes :

1. Rendre le script exécutable :
   

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

   Copier après la connexion

2. Déplacez le script vers un répertoire de votre PATH :
   

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

   Copier après la connexion

3. Assurez-vous que la clé API OpenAI est définie dans votre environnement :
   Ajoutez la ligne suivante à votre profil shell (par exemple, .bash_profile, .zshrc ou .bashrc) :
   

   export OPENAI_API_KEY='your_openai_api_key'
   

   Copier après la connexion

4. Rechargez votre profil :
   

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

   Copier après la connexion

Étape 4 : Exécuter le script

Assurez-vous d'avoir effectué les modifications en exécutant :

git add .

Exécutez ensuite votre script depuis n'importe quel répertoire :

generate_commit_message

Vous devriez voir un message de validation généré imprimé dans votre terminal.

Conclusion

En tirant parti de ChatGPT avec un simple script Python, vous pouvez automatiser la génération de messages de validation Git significatifs. Cela permet non seulement de gagner du temps, mais garantit également que votre historique de validation est à la fois informatif et bien documenté. Rendre le script exécutable à partir de n'importe quel répertoire sur macOS rationalise davantage votre flux de travail. N'hésitez pas à personnaliser le script pour mieux répondre à vos besoins ou étendre ses fonctionnalités. Bon codage !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!