Guida: automatizzare il controllo delle versioni con Git e Python

Automatizzare il controllo delle versioni in Python utilizzando Git Hooks

Script Python per Hook pre-push

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

Configurazione di Git Hook per l'incremento della versione

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

Domande comuni sull'automazione del controllo delle versioni con Git e Python

1. Come posso automatizzare il controllo delle versioni nel mio repository Git?
2. Puoi automatizzare il controllo delle versioni utilizzando gli hook Git, come l'hook pre-push, e gli script per aggiornare un file di versione su ogni commit.
3. Cos'è un gancio pre-spinto?
4. Un hook pre-push è un hook Git che esegue gli script prima che le modifiche vengano inviate a un repository remoto. Può essere utilizzato per automatizzare attività come l'aggiornamento di un file di versione.
5. Come posso accedere al messaggio di commit in uno script hook Git?
6. È possibile accedere al messaggio di commit leggendo il file passato come argomento allo script, in genere utilizzando sys.argv in Python o $1 in uno script di shell.
7. Quale comando recupera l'ultimo hash del commit Git?
8. Il comando git rev-parse HEAD recupera l'ultimo hash di commit in un repository Git.
9. Come posso incrementare il numero di versione in uno script?
10. Utilizza le espressioni regolari per estrarre la versione corrente, incrementare il numero di patch e riscrivere il file di versione con il nuovo numero di versione.
11. Posso utilizzare questo metodo con strumenti di integrazione continua?
12. Sì, l'automazione del controllo delle versioni con gli hook Git può essere integrata nelle pipeline CI/CD per garantire la coerenza delle versioni tra build e distribuzioni.
13. Quali sono i vantaggi del controllo delle versioni automatizzato?
14. Il controllo delle versioni automatizzato riduce gli errori manuali, garantisce un monitoraggio coerente delle versioni e semplifica il processo di sviluppo e distribuzione.
15. Come posso assicurarmi che il file di versione sia incluso nel prossimo commit?
16. Utilizzo git add per mettere in scena il file di versione dopo che è stato aggiornato dallo script.
17. Cosa succede se il file della versione non esiste?
18. Se il file di versione non esiste, lo script può crearlo con un numero di versione iniziale, ad esempio 0.0.1.
19. È possibile utilizzare altri linguaggi di programmazione per gli hook Git?
20. Sì, puoi scrivere script hook Git in vari linguaggi di programmazione, come Python, Bash o Perl, a seconda delle tue preferenze e dei requisiti del progetto.