mirror of
https://github.com/bndr/pipreqs.git
synced 2025-06-06 03:25:21 +00:00
4a88a2fc78
**TL;DR: this post-commit hook ensures that valid versions are automatically tagged based on changes in the `pyproject.toml` file.**
This post-commit hook automates the tagging of the project based on changes in the `pyproject.toml` file. Here's a breakdown of what it does:
**1. Extracting the version number:**
* `git diff HEAD^..HEAD`: This line compares the current commit (`HEAD`) to its immediate predecessor (`HEAD^`).
* `-- "$(git rev-parse --show-toplevel)"/pyproject.toml`: This specifies the `pyproject.toml` file within the project root directory.
* `grep -m 1 '^\+.*version'`: This searches for the first line starting with a "+" and containing the word "version".
* `sed -s 's/[^A-Z0-9\.\-]//g'`: This removes any characters except numbers, letters, dots, and hyphens from the matched line.
* `version=`: Finally, the extracted version string is stored in the `version` variable.
**2. Validating the version format:**
* `if [[ ! $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)(\-[A-Z]+\.[0-9]+)?$ ]]; then`: This checks if the extracted version string matches a specific format:
* `^`: Starts with the beginning of the string.
* `([0-9]+)`: Matches one or more digits (major version).
* `\.`: Matches a literal dot.
* `([0-9]+)`: Matches one or more digits (minor version).
* `\.`: Matches a literal dot.
* `([0-9]+)`: Matches one or more digits (patch version).
* `(\-[A-Z]+\.[0-9]+)?`: This is optional and matches a hyphen followed by one or more uppercase letters and a dot and another number (pre-release + build information).
* `$`: Matches the end of the string.
* If the format is invalid, it logs a message and exits with an error code.
**3. Creating the tag:**
* `git tag -a "v$version"`: This creates a new annotated tag named `v$version` (with the prefix "v") using the extracted version number.
* ``-m "`git log -1 --format=%s`"``: This sets the tag message with the full commit message of the current commit.
* `echo "Created a new tag, v$version"`: This prints a confirmation message.
Co-authored-by: Darwish Ahmad Herati <13837531+daherati@users.noreply.github.com>
10 lines
388 B
Bash
Executable File
10 lines
388 B
Bash
Executable File
#! /bin/bash
|
|
version=`git diff HEAD^..HEAD -- "$(git rev-parse --show-toplevel)"/pyproject.toml | grep -m 1 '^\+.*version' | sed -s 's/[^A-Z0-9\.\-]//g'`
|
|
|
|
if [[ ! $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)(\-[A-Z]+\.[0-9]+)?$ ]]; then
|
|
echo -e "Skip tag: invalid version '$version'"
|
|
exit 1
|
|
fi
|
|
|
|
git tag -a "v$version" -m "`git log -1 --format=%s`"
|
|
echo "Created a new tag, v$version" |