Leitfaden: Versionierung mit Git und Python automatisieren

Automatisieren der Versionierung in Python mithilfe von Git-Hooks

Python-Skript für 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 für Versionsinkrement einrichten

Git-Hook-Skript in der 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

Häufige Fragen zur Automatisierung der Versionierung mit Git und Python

1. Wie kann ich die Versionierung in meinem Git-Repository automatisieren?
2. Sie können die Versionierung automatisieren, indem Sie Git-Hooks wie den Pre-Push-Hook und Skripte verwenden, um bei jedem Commit eine Versionsdatei zu aktualisieren.
3. Was ist ein Pre-Push-Haken?
4. Ein Pre-Push-Hook ist ein Git-Hook, der Skripte ausführt, bevor Änderungen an ein Remote-Repository übertragen werden. Es kann zur Automatisierung von Aufgaben wie der Aktualisierung einer Versionsdatei verwendet werden.
5. Wie greife ich in einem Git-Hook-Skript auf die Commit-Nachricht zu?
6. Sie können auf die Commit-Nachricht zugreifen, indem Sie die als Argument an das Skript übergebene Datei lesen, normalerweise mit sys.argv in Python oder $1 in einem Shell-Skript.
7. Welcher Befehl ruft den neuesten Git-Commit-Hash ab?
8. Der Befehl git rev-parse HEAD Ruft den neuesten Commit-Hash in einem Git-Repository ab.
9. Wie erhöhe ich die Versionsnummer in einem Skript?
10. Verwenden Sie reguläre Ausdrücke, um die aktuelle Version zu extrahieren, die Patch-Nummer zu erhöhen und die Versionsdatei mit der neuen Versionsnummer neu zu schreiben.
11. Kann ich diese Methode mit Continuous-Integration-Tools verwenden?
12. Ja, die Automatisierung der Versionierung mit Git-Hooks kann in CI/CD-Pipelines integriert werden, um die Versionskonsistenz über Builds und Bereitstellungen hinweg sicherzustellen.
13. Welche Vorteile bietet die automatisierte Versionierung?
14. Die automatisierte Versionierung reduziert manuelle Fehler, sorgt für eine konsistente Versionsverfolgung und optimiert den Entwicklungs- und Bereitstellungsprozess.
15. Wie stelle ich sicher, dass die Versionsdatei im nächsten Commit enthalten ist?
16. Verwenden git add um die Versionsdatei bereitzustellen, nachdem sie vom Skript aktualisiert wurde.
17. Was passiert, wenn die Versionsdatei nicht existiert?
18. Wenn die Versionsdatei nicht vorhanden ist, kann das Skript sie mit einer anfänglichen Versionsnummer erstellen, z. B. 0.0.1.
19. Ist es möglich, andere Programmiersprachen für Git-Hooks zu verwenden?
20. Ja, Sie können Git-Hook-Skripte in verschiedenen Programmiersprachen wie Python, Bash oder Perl schreiben, je nach Ihren Vorlieben und Projektanforderungen.