Panduan: Automatikkan Versi dengan Git dan Python

Lucas Simon

Isnin, 20 Mei 2024 9:19:41 PG

Mencipta Sistem Versi dengan Git dan Python

Mengautomatikkan versi fail projek anda adalah penting untuk mengekalkan aliran kerja pembangunan yang teratur dan cekap. Dengan menggunakan Git dan Python, anda boleh mencipta sistem yang mengemas kini fail version.py dengan setiap komit. Ini memastikan bahawa versi projek anda sentiasa tepat dan mencerminkan perubahan terkini yang dibuat pada pangkalan kod anda.

Dalam panduan ini, kami akan meneroka kaedah untuk mengemas kini fail version.py secara automatik apabila setiap push ke repositori Git anda. Kami akan membincangkan pelaksanaan skrip yang menangkap butiran komit, menambah nombor versi dan menyepadukan dengan lancar dengan aliran kerja Git anda.

Mengautomasikan Versi dalam Python Menggunakan Git Hooks

Skrip Python untuk Cangkuk Pra-tolak

#!/usr/bin/env /usr/bin/python
import os
import subprocess
import re
import sys

commit_msg_file = sys.argv[1]
with open(commit_msg_file, 'r') as file:
    commit_msg = file.read().strip()

version_file = os.path.abspath('version.py')
hashed_code = subprocess.check_output(['git', 'rev-parse', 'HEAD']).strip().decode('utf-8')

if os.path.exists(version_file):
    print(f'Reading previous {version_file}')
    with open(version_file, 'r') as f:
        content = f.read()
        major, minor, patch = map(int, re.search(r'version = "(\d+)\.(\d+)\.(\d+)"', content).groups())
    patch += 1
else:
    print(f'Creating new {version_file}')
    major, minor, patch = 0, 0, 1

print(f'Writing contents of {version_file} with "{commit_msg}"')
with open(version_file, 'w') as f:
    f.write(f'''# This file is created by the pre-push script
class Version:
    comment = "{commit_msg}"
    hash = "{hashed_code}"
    version = "{major}.{minor}.{patch}"

if __name__ == "__main__":
    print(Version.version)
''')

subprocess.call(['git', 'add', version_file])

Menyediakan Git Hook untuk Peningkatan Versi

Skrip Git Hook dalam Shell

#!/bin/sh

VERSION_PY="version.py"

# Get the commit message file from the arguments
COMMIT_MSG_FILE=$1

# Extract the commit message
COMMIT_MSG=$(cat $COMMIT_MSG_FILE)

# Get the latest commit hash
GIT_HASH=$(git rev-parse HEAD)

if [ -f "$VERSION_PY" ]; then
  VERSION=$(grep -oP '(?<=version = ")(\d+\.\d+\.\d+)' $VERSION_PY)
  IFS='.' read -r -a VERSION_PARTS <<< "$VERSION"
  VERSION_PARTS[2]=$((VERSION_PARTS[2] + 1))
  NEW_VERSION="${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.${VERSION_PARTS[2]}"
else
  NEW_VERSION="0.0.1"
fi

echo "# This file is created by the pre-push script" > $VERSION_PY
echo "class Version:" >> $VERSION_PY
echo "    comment = \"$COMMIT_MSG\"" >> $VERSION_PY
echo "    hash = \"$GIT_HASH\"" >> $VERSION_PY
echo "    version = \"$NEW_VERSION\"" >> $VERSION_PY

git add $VERSION_PY

Meningkatkan Aliran Kerja Git dengan Versi Automatik

Mengautomasikan versi dalam aliran kerja Git bukan sahaja memastikan konsistensi tetapi juga meningkatkan kebolehkesanan dalam projek perisian. Dengan menyepadukan pengurusan versi terus ke dalam cangkuk Git, pembangun boleh mengekalkan proses yang lancar dan cekap. Satu pendekatan ialah menggunakan cangkuk pra-tekan Git untuk mengemas kini fail versi secara automatik dengan setiap komit. Kaedah ini melibatkan menangkap mesej komit dan nilai cincang, yang penting untuk menjejaki perubahan dan mengekalkan rekod sejarah pangkalan kod.

Satu lagi aspek penting ialah keupayaan untuk mengembalikan perubahan dengan tepat. Dengan fail versi terkini, pembangun boleh menentukan keadaan sebenar projek pada mana-mana versi tertentu. Ini amat berguna dalam persekitaran penyepaduan dan penggunaan berterusan (CI/CD), di mana automasi adalah kunci. Memastikan fail versi dikemas kini dengan pasti dengan setiap komit membantu mengekalkan saluran paip penggunaan yang mantap, mengurangkan ralat manual dan memperkemas keluaran.

Bagaimanakah saya boleh mengautomasikan versi dalam repositori Git saya?
Anda boleh mengautomasikan versi dengan menggunakan cangkuk Git, seperti cangkuk pra-tekan dan skrip untuk mengemas kini fail versi pada setiap komit.
Apakah cangkuk pra-tolak?
Cangkuk pra-tekan ialah cangkuk Git yang menjalankan skrip sebelum perubahan ditolak ke repositori jauh. Ia boleh digunakan untuk mengautomasikan tugas seperti mengemas kini fail versi.
Bagaimanakah cara saya mengakses mesej komit dalam skrip cangkuk Git?
Anda boleh mengakses mesej komit dengan membaca fail yang diluluskan sebagai hujah kepada skrip, biasanya menggunakan dalam Python atau dalam skrip shell.
Apakah arahan yang mendapatkan semula cincang komit Git terkini?
Perintah itu mendapatkan semula cincang komit terkini dalam repositori Git.
Bagaimanakah cara saya menambah nombor versi dalam skrip?
Gunakan ungkapan biasa untuk mengekstrak versi semasa, menambah nombor tampalan dan menulis semula fail versi dengan nombor versi baharu.
Bolehkah saya menggunakan kaedah ini dengan alat penyepaduan berterusan?
Ya, mengautomasikan versi dengan cangkuk Git boleh disepadukan ke dalam saluran paip CI/CD untuk memastikan konsistensi versi merentas binaan dan penggunaan.
Apakah faedah versi automatik?
Versi automatik mengurangkan ralat manual, memastikan penjejakan versi yang konsisten dan menyelaraskan proses pembangunan dan penggunaan.
Bagaimanakah cara saya memastikan fail versi disertakan dalam komit seterusnya?
guna untuk mementaskan fail versi selepas ia dikemas kini oleh skrip.
Apa yang berlaku jika fail versi tidak wujud?
Jika fail versi tidak wujud, skrip boleh menciptanya dengan nombor versi awal, seperti 0.0.1.
Adakah mungkin untuk menggunakan bahasa pengaturcaraan lain untuk cangkuk Git?
Ya, anda boleh menulis skrip cangkuk Git dalam pelbagai bahasa pengaturcaraan, seperti Python, Bash, atau Perl, bergantung pada keutamaan dan keperluan projek anda.

Pemikiran Akhir tentang Versi Automatik

Mengautomasikan kemas kini fail version.py dengan setiap push Git ialah penyelesaian praktikal untuk mengekalkan kawalan versi yang tepat dalam projek anda. Skrip yang disediakan memanfaatkan cangkuk Git dan Python untuk mengautomasikan proses ini, memastikan setiap komit dijejaki dengan nombor versi yang dikemas kini, mesej komit dan cincang. Melaksanakan kaedah ini boleh meningkatkan aliran kerja anda, menjadikannya lebih cekap dan mengurangkan kemungkinan kesilapan manusia. Dengan mengikuti garis panduan dan contoh yang diberikan, anda boleh dengan mudah menyepadukan versi automatik ke dalam amalan pembangunan anda sendiri.