Guide : Automatiser la gestion des versions avec Git et Python

Automatisation de la gestion des versions en Python à l'aide de Git Hooks

Script Python pour le hook pré-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])

Configuration de Git Hook pour l'incrément de version

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

Questions courantes sur l'automatisation du contrôle de version avec Git et Python

1. Comment puis-je automatiser la gestion des versions dans mon référentiel Git ?
2. Vous pouvez automatiser la gestion des versions à l'aide de hooks Git, tels que le hook de pré-push, et de scripts pour mettre à jour un fichier de version à chaque validation.
3. Qu'est-ce qu'un crochet de pré-poussée ?
4. Un hook de pré-push est un hook Git qui exécute des scripts avant que les modifications ne soient transmises à un référentiel distant. Il peut être utilisé pour automatiser des tâches telles que la mise à jour d'un fichier de version.
5. Comment accéder au message de validation dans un script hook Git ?
6. Vous pouvez accéder au message de validation en lisant le fichier passé en argument au script, généralement en utilisant sys.argv en Python ou $1 dans un script shell.
7. Quelle commande récupère le dernier hachage de validation Git ?
8. La commande git rev-parse HEAD récupère le dernier hachage de validation dans un référentiel Git.
9. Comment incrémenter le numéro de version dans un script ?
10. Utilisez des expressions régulières pour extraire la version actuelle, incrémenter le numéro de correctif et réécrire le fichier de version avec le nouveau numéro de version.
11. Puis-je utiliser cette méthode avec des outils d’intégration continue ?
12. Oui, l'automatisation de la gestion des versions avec les hooks Git peut être intégrée aux pipelines CI/CD pour garantir la cohérence des versions entre les versions et les déploiements.
13. Quels sont les avantages du versioning automatisé ?
14. La gestion des versions automatisée réduit les erreurs manuelles, garantit un suivi cohérent des versions et rationalise le processus de développement et de déploiement.
15. Comment puis-je m'assurer que le fichier de version est inclus dans le prochain commit ?
16. Utiliser git add pour préparer le fichier de version après sa mise à jour par le script.
17. Que se passe-t-il si le fichier de version n'existe pas ?
18. Si le fichier de version n'existe pas, le script peut le créer avec un numéro de version initial, tel que 0.0.1.
19. Est-il possible d’utiliser d’autres langages de programmation pour les hooks Git ?
20. Oui, vous pouvez écrire des scripts hook Git dans différents langages de programmation, tels que Python, Bash ou Perl, en fonction de vos préférences et des exigences du projet.