Посібник: Автоматизація керування версіями за допомогою Git і Python

Автоматизація керування версіями в Python за допомогою хуків Git

Сценарій Python для Pre-push Hook

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

Налаштування Git Hook для збільшення версії

Сценарій Git Hook в 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

Поширені запитання щодо автоматизації керування версіями за допомогою Git і Python

1. Як я можу автоматизувати керування версіями у своєму сховищі Git?
2. Ви можете автоматизувати керування версіями, використовуючи перехоплювачі Git, такі як перехоплювач попереднього натискання, і сценарії для оновлення файлу версії під час кожного коміту.
3. Що таке гачок перед натисканням?
4. Хук перед надсиланням — це хук Git, який запускає сценарії до того, як зміни надсилаються до віддаленого репозиторію. Його можна використовувати для автоматизації таких завдань, як оновлення файлу версії.
5. Як отримати доступ до повідомлення коміту в сценарії підключення Git?
6. Ви можете отримати доступ до повідомлення фіксації, прочитавши файл, переданий як аргумент сценарію, зазвичай використовуючи sys.argv на Python або $1 у сценарії оболонки.
7. Яка команда отримує останній хеш коміту Git?
8. Команда git rev-parse HEAD отримує останній хеш коміту в сховищі Git.
9. Як збільшити номер версії сценарію?
10. Використовуйте регулярні вирази, щоб отримати поточну версію, збільшити номер виправлення та переписати файл версії з новим номером версії.
11. Чи можу я використовувати цей метод із інструментами постійної інтеграції?
12. Так, автоматизацію контролю версій за допомогою перехоплювачів Git можна інтегрувати в конвеєри CI/CD, щоб забезпечити узгодженість версій у збірках і розгортаннях.
13. Які переваги автоматизованого керування версіями?
14. Автоматизоване керування версіями зменшує кількість помилок вручну, забезпечує послідовне відстеження версій і оптимізує процес розробки та розгортання.
15. Як переконатися, що файл версії включено до наступного коміту?
16. використання git add для розміщення файлу версії після його оновлення сценарієм.
17. Що станеться, якщо файл версії не існує?
18. Якщо файл версії не існує, сценарій може створити його з початковим номером версії, наприклад 0.0.1.
19. Чи можна використовувати інші мови програмування для перехоплювачів Git?
20. Так, ви можете писати сценарії підключення Git різними мовами програмування, такими як Python, Bash або Perl, залежно від ваших уподобань і вимог проекту.