Guide: Automatiser versjonering med Git og Python

Lucas Simon

Mandag 20. mai 2024 09:22:55

Opprette et versjonssystem med Git og Python

Automatisering av versjonering av prosjektfilene dine er avgjørende for å opprettholde en organisert og effektiv utviklingsarbeidsflyt. Ved å bruke Git og Python kan du lage et system som oppdaterer en version.py-fil med hver commit. Dette sikrer at prosjektversjonen din alltid er nøyaktig og gjenspeiler de siste endringene som er gjort i kodebasen din.

I denne veiledningen vil vi utforske en metode for å automatisk oppdatere en version.py-fil ved hvert trykk til Git-depotet ditt. Vi vil diskutere implementeringen av et skript som fanger opp forpliktelsesdetaljer, øker versjonsnummeret og integreres sømløst med Git-arbeidsflyten din.

Automatisering av versjonering i Python ved hjelp av Git Hooks

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

Sette opp Git Hook for versjonstilvekst

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

Forbedre Git-arbeidsflyten med automatisert versjonskontroll

Automatisering av versjonering i en Git-arbeidsflyt sikrer ikke bare konsistens, men forbedrer også sporbarheten i programvareprosjekter. Ved å integrere versjonsadministrasjon direkte i Git hooks, kan utviklere opprettholde en sømløs og effektiv prosess. En tilnærming er å bruke Gits pre-push-hook for å automatisk oppdatere en versjonsfil med hver commit. Denne metoden innebærer å fange opp commit-meldinger og hash-verdier, som er avgjørende for å spore endringer og opprettholde en historisk oversikt over kodebasen.

Et annet viktig aspekt er muligheten til å tilbakestille endringer nøyaktig. Med en oppdatert versjonsfil kan utviklere finne den nøyaktige tilstanden til prosjektet ved en gitt versjon. Dette er spesielt nyttig i miljøer med kontinuerlig integrasjon og distribusjon (CI/CD), der automatisering er nøkkelen. Å sikre at versjonsfilen oppdateres pålitelig med hver commit bidrar til å opprettholde en robust distribusjonspipeline, redusere manuelle feil og strømlinjeforme utgivelser.

Hvordan kan jeg automatisere versjonering i Git-depotet mitt?
Du kan automatisere versjonering ved å bruke Git-hooks, for eksempel pre-push-hooken, og skript for å oppdatere en versjonsfil på hver commit.
Hva er en pre-push krok?
En pre-push-hook er en Git-hook som kjører skript før endringer skyves til et eksternt depot. Den kan brukes til å automatisere oppgaver som å oppdatere en versjonsfil.
Hvordan får jeg tilgang til commit-meldingen i et Git hook-skript?
Du kan få tilgang til commit-meldingen ved å lese filen som ble sendt som et argument til skriptet, vanligvis ved å bruke i Python eller i et skallskript.
Hvilken kommando henter den siste Git commit-hashen?
Kommandoen henter den siste commit-hashen i et Git-depot.
Hvordan øker jeg versjonsnummeret i et skript?
Bruk regulære uttrykk for å trekke ut den gjeldende versjonen, øke oppdateringsnummeret og omskriv versjonsfilen med det nye versjonsnummeret.
Kan jeg bruke denne metoden med kontinuerlige integreringsverktøy?
Ja, automatisering av versjonering med Git-hooks kan integreres i CI/CD-pipelines for å sikre versjonskonsistens på tvers av bygg og distribusjoner.
Hva er fordelene med automatisert versjonskontroll?
Automatisert versjonskontroll reduserer manuelle feil, sikrer konsistent versjonssporing og effektiviserer utviklings- og distribusjonsprosessen.
Hvordan sikrer jeg at versjonsfilen er inkludert i neste commit?
Bruk for å iscenesette versjonsfilen etter at den har blitt oppdatert av skriptet.
Hva skjer hvis versjonsfilen ikke eksisterer?
Hvis versjonsfilen ikke eksisterer, kan skriptet lage den med et opprinnelig versjonsnummer, for eksempel 0.0.1.
Er det mulig å bruke andre programmeringsspråk for Git hooks?
Ja, du kan skrive Git hook-skript på forskjellige programmeringsspråk, som Python, Bash eller Perl, avhengig av dine preferanser og prosjektkrav.

Siste tanker om automatisert versjonering

Automatisering av oppdateringen av en version.py-fil med hver Git-push er en praktisk løsning for å opprettholde nøyaktig versjonskontroll i prosjektene dine. De medfølgende skriptene utnytter Git hooks og Python for å automatisere denne prosessen, og sikrer at hver commit spores med et oppdatert versjonsnummer, commit-melding og hash. Implementering av denne metoden kan forbedre arbeidsflyten din betraktelig, gjøre den mer effektiv og redusere sjansene for menneskelige feil. Ved å følge retningslinjene og eksemplene kan du enkelt integrere automatisert versjonering i din egen utviklingspraksis.