Guide: Using Git and Python to Automate Versioning

Python Versioning Automation with Git Hooks

Python Code for Prior to 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])

Configuring a Git Hook to Track Version Increases

Shell Git Hook Script

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

Frequently Asked Questions about Git and Python Versioning Automation

1. How can versioning in my Git repository be automated?
2. Git hooks, like the pre-push hook, and scripts that update a version file with every commit can be used to automate versioning.
3. A pre-push hook: what is it?
4. A Git hook known as a pre-push hook is used to execute scripts prior to changes being pushed to a remote repository. It can be applied to automate processes like version file updates.
5. How can I use a Git hook script to retrieve the commit message?
6. By reading the file supplied as an input to the script—typically sys.argv in Python or $1 in a shell script—you can obtain the commit message.
7. Which command gets the most recent hash of a Git commit?
8. In a Git repository, the command git rev-parse HEAD gets the most recent commit hash.
9. How can I make a script's version number higher?
10. To extract the current version, increase the patch number, and rewrite the version file with the new version number, use regular expressions.
11. Can I utilize tools for continuous integration with this method?
12. Indeed, CI/CD pipelines can incorporate versioning automation using Git hooks to guarantee version consistency between builds and deploys.
13. What advantages does automatic versioning offer?
14. Automated versioning expedites the development and deployment process, guarantees consistent version tracking, and lowers human mistake rates.
15. How can I make sure that the upcoming commit has the version file?
16. After the script updates the version file, use git add to stage it.
17. What occurs in the event that the version file is missing?
18. The script can generate the version file with an initial version number, such 0.0.1, if it doesn't already exist.
19. Are Git hooks compatible with other programming languages?
20. Sure, you can develop Git hook scripts in Python, Bash, or Perl, among other computer languages, based on your needs and the requirements of the project.