Guide: Automatiser versionering med Git og Python

Automatisering af versionering i Python ved hjælp af Git Hooks

Python Script til 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])

Opsætning af Git Hook til Version Increment

Git Hook Script i 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

Almindelige spørgsmål om automatisering af versionering med Git og Python

1. Hvordan kan jeg automatisere versionering i mit Git-lager?
2. Du kan automatisere versionering ved at bruge Git hooks, såsom pre-push hook, og scripts til at opdatere en versionsfil på hver commit.
3. Hvad er en pre-push krog?
4. En pre-push hook er en Git hook, der kører scripts, før ændringer skubbes til et fjernlager. Det kan bruges til at automatisere opgaver såsom opdatering af en versionsfil.
5. Hvordan får jeg adgang til commit-meddelelsen i et Git hook-script?
6. Du kan få adgang til commit-meddelelsen ved at læse filen, der er sendt som et argument til scriptet, typisk ved at bruge sys.argv i Python eller $1 i et shell-script.
7. Hvilken kommando henter den seneste Git commit hash?
8. Kommandoen git rev-parse HEAD henter den seneste commit-hash i et Git-lager.
9. Hvordan øger jeg versionsnummeret i et script?
10. Brug regulære udtryk til at udtrække den aktuelle version, forøg patchnummeret og omskriv versionsfilen med det nye versionsnummer.
11. Kan jeg bruge denne metode med værktøjer til kontinuerlig integration?
12. Ja, automatisering af versionering med Git-hooks kan integreres i CI/CD-pipelines for at sikre versionskonsistens på tværs af builds og implementeringer.
13. Hvad er fordelene ved automatiseret versionering?
14. Automatiseret versionering reducerer manuelle fejl, sikrer ensartet versionssporing og strømliner udviklings- og implementeringsprocessen.
15. Hvordan sikrer jeg, at versionsfilen er inkluderet i den næste commit?
16. Brug git add at iscenesætte versionsfilen, efter at den er blevet opdateret af scriptet.
17. Hvad sker der, hvis versionsfilen ikke findes?
18. Hvis versionsfilen ikke findes, kan scriptet oprette den med et indledende versionsnummer, såsom 0.0.1.
19. Er det muligt at bruge andre programmeringssprog til Git hooks?
20. Ja, du kan skrive Git hook-scripts på forskellige programmeringssprog, såsom Python, Bash eller Perl, afhængigt af dine præferencer og projektkrav.