Průvodce: Automatizujte verzování pomocí Git a Python

Automatizace verzování v Pythonu pomocí Git Hooks

Python skript pro 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])

Nastavení Git Hooku pro přírůstek verze

Skript Git Hook v prostředí 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

Běžné otázky o automatizaci verzování pomocí Git a Python

1. Jak mohu automatizovat verzování v mém úložišti Git?
2. Můžete automatizovat verzování pomocí Git hooků, jako je pre-push hook, a skriptů k aktualizaci souboru verze při každém odevzdání.
3. Co je to předtlačený hák?
4. Pre-push hook je Git hook, který spouští skripty před odesláním změn do vzdáleného úložiště. Lze jej použít k automatizaci úloh, jako je aktualizace souboru verze.
5. Jak získám přístup ke zprávě odevzdání ve skriptu Git hook?
6. Ke zprávě odevzdání se můžete dostat přečtením souboru předaného jako argument skriptu, obvykle pomocí sys.argv v Pythonu nebo $1 ve skriptu shellu.
7. Jaký příkaz načte nejnovější hash potvrzení Git?
8. Příkaz git rev-parse HEAD načte nejnovější hash potvrzení v úložišti Git.
9. Jak zvýším číslo verze ve skriptu?
10. Pomocí regulárních výrazů extrahujte aktuální verzi, zvyšte číslo opravy a přepište soubor verze s novým číslem verze.
11. Mohu tuto metodu použít s nástroji průběžné integrace?
12. Ano, automatizaci verzování pomocí Git hooků lze integrovat do kanálů CI/CD, aby byla zajištěna konzistence verzí napříč sestaveními a nasazeními.
13. Jaké jsou výhody automatického verzování?
14. Automatizované verzování snižuje ruční chyby, zajišťuje konzistentní sledování verzí a zefektivňuje proces vývoje a nasazení.
15. Jak zajistím, aby byl soubor verze zahrnut v příštím odevzdání?
16. Použití git add k vytvoření souboru verze poté, co byl skriptem aktualizován.
17. Co se stane, když soubor verze neexistuje?
18. Pokud soubor verze neexistuje, skript jej může vytvořit s počátečním číslem verze, například 0.0.1.
19. Je možné pro Git hooky použít jiné programovací jazyky?
20. Ano, skripty Git hook můžete psát v různých programovacích jazycích, jako je Python, Bash nebo Perl, v závislosti na vašich preferencích a požadavcích projektu.