Руководство. Автоматизация управления версиями с помощью Git и Python

Автоматизация управления версиями в Python с помощью Git Hooks

Скрипт Python для крючка предварительного нажатия

#!/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, в зависимости от ваших предпочтений и требований проекта.