Automatikkan Mesej Komit Git Anda dengan ChatGPT

Mencipta mesej komitmen yang bermakna dan ringkas ialah bahagian penting dalam aliran kerja pembangunan yang baik. Mesej ini membantu dalam menjejaki perubahan, memahami sejarah projek dan bekerjasama dengan ahli pasukan. Tetapi mari kita akui—menulis mesej komitmen kadangkala boleh menjadi tugas biasa. Dalam artikel ini, kami akan membimbing anda melalui cara menggunakan ChatGPT OpenAI untuk menjana mesej komit Git secara automatik dan cara menjalankan skrip ini daripada mana-mana direktori pada sistem macOS anda.

Prasyarat

Untuk mengikuti, anda memerlukan:

• Pengetahuan asas Python.
• Git dipasang pada mesin anda.
• Akaun di OpenAI dan kunci API. Jika anda belum mempunyai kunci API, anda boleh belajar cara menjananya dengan mengikuti panduan ini untuk mencipta kunci API OpenAI.

Langkah 1: Sediakan Persekitaran

Mula-mula, pasang pakej Openai Python:

pip install openai

Seterusnya, tetapkan kunci API OpenAI anda sebagai pembolehubah persekitaran:

export OPENAI_API_KEY='your_openai_api_key'

Langkah 2: Menulis Skrip Python

Berikut ialah skrip 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()

Simpan skrip ini pada fail bernama generate_commit_message.py.

Langkah 3: Menjadikan Skrip Boleh Laksana dan Boleh Diakses

Untuk menjadikan skrip boleh laku dan boleh diakses daripada mana-mana direktori, ikut langkah berikut:

1. Jadikan Skrip Boleh Laksana:
   

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

2. Alihkan Skrip ke Direktori dalam PATH Anda:
   

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

3. Pastikan Kunci API OpenAI Ditetapkan dalam Persekitaran Anda:
   Tambahkan baris berikut pada profil shell anda (cth., .bash_profile, .zshrc atau .bashrc):
   

   export OPENAI_API_KEY='your_openai_api_key'
   

4. Muat Semula Profil Anda:
   

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

Langkah 4: Menjalankan Skrip

Pastikan anda telah membuat perubahan secara berperingkat dengan menjalankan:

git add .

Kemudian laksanakan skrip anda dari mana-mana direktori:

generate_commit_message

Anda sepatutnya melihat mesej komit yang dijana dicetak dalam terminal anda.

Kesimpulan

Dengan memanfaatkan ChatGPT dengan skrip Python yang ringkas, anda boleh mengautomasikan penjanaan mesej komit Git yang bermakna. Ini bukan sahaja menjimatkan masa tetapi juga memastikan bahawa sejarah komitmen anda adalah bermaklumat dan didokumentasikan dengan baik. Membuat skrip boleh laku daripada mana-mana direktori pada macOS menyelaraskan aliran kerja anda dengan lebih lanjut. Jangan ragu untuk menyesuaikan skrip agar lebih sesuai dengan keperluan anda atau melanjutkan fungsinya. Selamat mengekod!

Atas ialah kandungan terperinci Automatikkan Mesej Komit Git Anda dengan ChatGPT. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!