Przewodnik: Automatyzacja wersjonowania za pomocą Git i Pythona

Automatyzacja wersjonowania w Pythonie przy użyciu haków Git

Skrypt Pythona dla haka przed pushem

#!/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])

Konfigurowanie haka Git do zwiększania wersji

Skrypt Git Hook w powłoce

#!/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

Często zadawane pytania dotyczące automatyzacji wersjonowania za pomocą Git i Pythona

1. Jak mogę zautomatyzować wersjonowanie w moim repozytorium Git?
2. Możesz zautomatyzować wersjonowanie, używając haków Git, takich jak hak przed wypychaniem, i skryptów aktualizujących plik wersji przy każdym zatwierdzeniu.
3. Co to jest hak przed wciśnięciem?
4. Hak przed wypychaniem to hak Gita, który uruchamia skrypty przed wypchnięciem zmian do zdalnego repozytorium. Można go używać do automatyzacji zadań, takich jak aktualizacja pliku wersji.
5. Jak uzyskać dostęp do komunikatu zatwierdzenia w skrypcie przechwytującym Git?
6. Dostęp do komunikatu zatwierdzenia można uzyskać, czytając plik przekazany jako argument do skryptu, zwykle za pomocą sys.argv w Pythonie lub $1 w skrypcie powłoki.
7. Jakie polecenie pobiera najnowszy skrót zatwierdzenia Git?
8. Komenda git rev-parse HEAD pobiera najnowszy skrót zatwierdzenia w repozytorium Git.
9. Jak zwiększyć numer wersji w skrypcie?
10. Użyj wyrażeń regularnych, aby wyodrębnić bieżącą wersję, zwiększyć numer poprawki i ponownie zapisać plik wersji z nowym numerem wersji.
11. Czy mogę używać tej metody z narzędziami do ciągłej integracji?
12. Tak, automatyzację wersjonowania za pomocą haków Git można zintegrować z potokami CI/CD, aby zapewnić spójność wersji między kompilacjami i wdrożeniami.
13. Jakie są zalety automatycznego wersjonowania?
14. Zautomatyzowane wersjonowanie zmniejsza liczbę błędów ręcznych, zapewnia spójne śledzenie wersji oraz usprawnia proces programowania i wdrażania.
15. Jak mogę się upewnić, że plik wersji zostanie uwzględniony w następnym zatwierdzeniu?
16. Używać git add do przygotowania pliku wersji po jego zaktualizowaniu przez skrypt.
17. Co się stanie, jeśli plik wersji nie istnieje?
18. Jeśli plik wersji nie istnieje, skrypt może go utworzyć z początkowym numerem wersji, np. 0.0.1.
19. Czy można używać innych języków programowania dla haków Git?
20. Tak, możesz pisać skrypty przechwytujące Git w różnych językach programowania, takich jak Python, Bash lub Perl, w zależności od preferencji i wymagań projektu.