git-version-utils 0.1.0.0__tar.gz → 0.2.0.0__tar.gz

git_version_utils-0.2.0.0/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: git-version-utils
+Version: 0.2.0.0
+Summary: Extract version information from a Git repository and output as environment variables
+Author-email: Mikhail Milovidov <synacker@yandex.ru>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/synacker/git_version_utils
+Project-URL: Repository, https://github.com/synacker/git_version_utils
+Keywords: git,version,build,ci,cd
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# git-version-utils
+
+Extract version information from a Git repository and output as environment variables.
+
+## Installation
+
+```bash
+pip install git-version-utils
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Print all version info
+git-version
+
+# Output as environment variables (useful with `source` or `eval`)
+git-version --property env
+
+# Custom prefix for environment variables
+git-version --prefix MYAPP --property env
+
+# Custom tag pattern
+git-version --tag-pattern "release-*" --property env
+
+# Get a single property
+git-version --property version
+git-version --property version_major
+git-version --property commit
+
+# Specify repository path
+git-version --repo /path/to/repo --property env
+```
+
+### Python API
+
+```python
+from git_version import GitVersion
+
+gv = GitVersion(repo_path="/path/to/repo", tag_pattern="v[0-9]*")
+
+print(gv.version)       # "1.2.3.42"
+print(gv.version_major) # "1"
+print(gv.version_minor) # "2"
+print(gv.version_patch) # "3"
+print(gv.build)         # "42"
+print(gv.tag)           # "v1.2.3"
+print(gv.branch)        # "main"
+print(gv.short)         # "a1b2c3"
+print(gv.full)          # "1.2.3.42-a1b2c3"
+print(gv.commit)        # "a1b2c3d4e5f6..."
+
+# Get all as environment variables
+env_vars = gv.env(prefix="BUILD_VERSION")
+for key, value in env_vars.items():
+    print(f"{key}={value}")
+```
+
+## Environment Variables Output
+
+With default prefix `BUILD_VERSION`:
+
+| Variable | Example | Description |
+|---|---|---|
+| `BUILD_VERSION` | `1.2.3.42` | Full version: `<semver>.<build>` |
+| `BUILD_VERSION_MAJOR` | `1` | Major version component |
+| `BUILD_VERSION_MINOR` | `2` | Minor version component |
+| `BUILD_VERSION_PATCH` | `3` | Patch version component |
+| `BUILD_VERSION_BUILD` | `42` | Commits since last tag |
+| `BUILD_VERSION_TAG` | `v1.2.3` | Latest matching git tag |
+| `BUILD_VERSION_FULL` | `1.2.3.42-a1b2c3` | Version with commit hash |
+| `BUILD_VERSION_EXTENDED` | `1.2.3.42-a1b2c3` | Full if build>0, else version |
+| `BUILD_VERSION_SHORT` | `a1b2c3` | Short 6-char commit hash |
+| `BUILD_VERSION_COMMIT` | `a1b2c3d4...` | Full 40-char commit hash |
+| `BUILD_VERSION_BRANCH` | `main` | Current branch name |
+| `BUILD_VERSION_DEFAULT_BRANCH` | `master` | Default branch from git config |
+
+## CI/CD Integration
+
+### Shell (source)
+
+```bash
+source <(git-version --property env)
+echo "$BUILD_VERSION"
+```
+
+### CMake
+
+```cmake
+execute_process(
+    COMMAND git-version --property env
+    OUTPUT_VARIABLE GIT_VERSION_ENV
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+```
+
+### Docker
+
+```dockerfile
+RUN pip install git-version-utils
+RUN source <(git-version --property env) && echo "Building $BUILD_VERSION"
+```
+
+## Docker CI Container
+
+A pre-built Docker image with `git-version-utils` is available at
+`ghcr.io/synacker/git-version-utils`.
+
+The image is based on `python:3.13-slim` and includes `git` + `git-version-utils`.
+It is designed to be used as the **job container** in CI pipelines.
+
+### Usage
+
+```bash
+# Run git-version inside the container
+docker run --rm \
+  -v $(pwd):/workspace -w /workspace \
+  ghcr.io/synacker/git-version-utils:latest \
+  git-version --safe-directory '*' --property env
+```
+
+### GitHub Actions — Job Outputs
+
+Use `container:` to run the job inside the image, then parse `git-version --property env`
+into `$GITHUB_OUTPUT`. Downstream jobs consume the values via `needs.set-version.outputs.*`.
+
+```yaml
+name: CI with job outputs
+
+on:
+  push:
+    branches: [main, "release/*"]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/synacker/git-version-utils:latest
+      options: --workdir /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
+    outputs:
+      BUILD_VERSION: ${{ steps.git_version.outputs.BUILD_VERSION }}
+      BUILD_VERSION_MAJOR: ${{ steps.git_version.outputs.BUILD_VERSION_MAJOR }}
+      BUILD_VERSION_MINOR: ${{ steps.git_version.outputs.BUILD_VERSION_MINOR }}
+      BUILD_VERSION_PATCH: ${{ steps.git_version.outputs.BUILD_VERSION_PATCH }}
+      BUILD_VERSION_BUILD: ${{ steps.git_version.outputs.BUILD_VERSION_BUILD }}
+      BUILD_VERSION_TAG: ${{ steps.git_version.outputs.BUILD_VERSION_TAG }}
+      BUILD_VERSION_FULL: ${{ steps.git_version.outputs.BUILD_VERSION_FULL }}
+      BUILD_VERSION_EXTENDED: ${{ steps.git_version.outputs.BUILD_VERSION_EXTENDED }}
+      BUILD_VERSION_SHORT: ${{ steps.git_version.outputs.BUILD_VERSION_SHORT }}
+      BUILD_VERSION_COMMIT: ${{ steps.git_version.outputs.BUILD_VERSION_COMMIT }}
+      BUILD_VERSION_BRANCH: ${{ steps.git_version.outputs.BUILD_VERSION_BRANCH }}
+      BUILD_VERSION_DEFAULT_BRANCH: ${{ steps.git_version.outputs.BUILD_VERSION_DEFAULT_BRANCH }}
+      BUILD_VERSION_RELEASE_BRANCHES: ${{ steps.git_version.outputs.BUILD_VERSION_RELEASE_BRANCHES }}
+
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+
+      - name: Extract version info
+        id: git_version
+        run: |
+          while IFS='=' read -r key value; do
+            echo "$key=$value" >> "$GITHUB_OUTPUT"
+          done < <(git-version --property env)
+
+  build:
+    runs-on: ubuntu-latest
+    needs: set-version
+    steps:
+      - uses: actions/checkout@v6.0.3
+
+      - name: Use version info
+        run: |
+          echo "Building version: ${{ needs.set-version.outputs.BUILD_VERSION }}"
+          echo "Tag: ${{ needs.set-version.outputs.BUILD_VERSION_TAG }}"
+```
+
+### GitHub Actions — Env File Artifact
+
+A simpler approach: write the version info to a file and share it as an artifact.
+
+```yaml
+name: CI with env file
+
+on:
+  push:
+    branches: [main, "release/*"]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/synacker/git-version-utils:latest
+      options: --workdir /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+
+      - name: Generate version.env
+        run: git-version --property env > version.env
+
+      - name: Upload version env file
+        uses: actions/upload-artifact@v4
+        with:
+          name: version-env
+          path: version.env
+
+  build:
+    runs-on: ubuntu-latest
+    needs: set-version
+    steps:
+      - uses: actions/checkout@v6.0.3
+
+      - name: Download version env file
+        uses: actions/download-artifact@v4
+        with:
+          name: version-env
+
+      - name: Load version and use it
+        run: |
+          source version.env
+          echo "Building version: $BUILD_VERSION"
+          echo "Tag: $BUILD_VERSION_TAG"
+```
+
+### GitLab CI
+
+Use the image directly and share version info via
+[dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv).
+
+```yaml
+stages:
+  - set-version
+  - build
+
+set-version:
+  stage: set-version
+  image: ghcr.io/synacker/git-version-utils:latest
+  variables:
+    GIT_DEPTH: 0
+  script:
+    - git-version --property env > version.env
+  artifacts:
+    reports:
+      dotenv: version.env
+
+build:
+  stage: build
+  image: python:3.13-slim
+  needs:
+    - job: set-version
+      artifacts: true
+  script:
+    - echo "Building version: $BUILD_VERSION"
+    - echo "Tag: $BUILD_VERSION_TAG"

git_version_utils-0.2.0.0/README.md

@@ -0,0 +1,259 @@
+# git-version-utils
+
+Extract version information from a Git repository and output as environment variables.
+
+## Installation
+
+```bash
+pip install git-version-utils
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Print all version info
+git-version
+
+# Output as environment variables (useful with `source` or `eval`)
+git-version --property env
+
+# Custom prefix for environment variables
+git-version --prefix MYAPP --property env
+
+# Custom tag pattern
+git-version --tag-pattern "release-*" --property env
+
+# Get a single property
+git-version --property version
+git-version --property version_major
+git-version --property commit
+
+# Specify repository path
+git-version --repo /path/to/repo --property env
+```
+
+### Python API
+
+```python
+from git_version import GitVersion
+
+gv = GitVersion(repo_path="/path/to/repo", tag_pattern="v[0-9]*")
+
+print(gv.version)       # "1.2.3.42"
+print(gv.version_major) # "1"
+print(gv.version_minor) # "2"
+print(gv.version_patch) # "3"
+print(gv.build)         # "42"
+print(gv.tag)           # "v1.2.3"
+print(gv.branch)        # "main"
+print(gv.short)         # "a1b2c3"
+print(gv.full)          # "1.2.3.42-a1b2c3"
+print(gv.commit)        # "a1b2c3d4e5f6..."
+
+# Get all as environment variables
+env_vars = gv.env(prefix="BUILD_VERSION")
+for key, value in env_vars.items():
+    print(f"{key}={value}")
+```
+
+## Environment Variables Output
+
+With default prefix `BUILD_VERSION`:
+
+| Variable | Example | Description |
+|---|---|---|
+| `BUILD_VERSION` | `1.2.3.42` | Full version: `<semver>.<build>` |
+| `BUILD_VERSION_MAJOR` | `1` | Major version component |
+| `BUILD_VERSION_MINOR` | `2` | Minor version component |
+| `BUILD_VERSION_PATCH` | `3` | Patch version component |
+| `BUILD_VERSION_BUILD` | `42` | Commits since last tag |
+| `BUILD_VERSION_TAG` | `v1.2.3` | Latest matching git tag |
+| `BUILD_VERSION_FULL` | `1.2.3.42-a1b2c3` | Version with commit hash |
+| `BUILD_VERSION_EXTENDED` | `1.2.3.42-a1b2c3` | Full if build>0, else version |
+| `BUILD_VERSION_SHORT` | `a1b2c3` | Short 6-char commit hash |
+| `BUILD_VERSION_COMMIT` | `a1b2c3d4...` | Full 40-char commit hash |
+| `BUILD_VERSION_BRANCH` | `main` | Current branch name |
+| `BUILD_VERSION_DEFAULT_BRANCH` | `master` | Default branch from git config |
+
+## CI/CD Integration
+
+### Shell (source)
+
+```bash
+source <(git-version --property env)
+echo "$BUILD_VERSION"
+```
+
+### CMake
+
+```cmake
+execute_process(
+    COMMAND git-version --property env
+    OUTPUT_VARIABLE GIT_VERSION_ENV
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+```
+
+### Docker
+
+```dockerfile
+RUN pip install git-version-utils
+RUN source <(git-version --property env) && echo "Building $BUILD_VERSION"
+```
+
+## Docker CI Container
+
+A pre-built Docker image with `git-version-utils` is available at
+`ghcr.io/synacker/git-version-utils`.
+
+The image is based on `python:3.13-slim` and includes `git` + `git-version-utils`.
+It is designed to be used as the **job container** in CI pipelines.
+
+### Usage
+
+```bash
+# Run git-version inside the container
+docker run --rm \
+  -v $(pwd):/workspace -w /workspace \
+  ghcr.io/synacker/git-version-utils:latest \
+  git-version --safe-directory '*' --property env
+```
+
+### GitHub Actions — Job Outputs
+
+Use `container:` to run the job inside the image, then parse `git-version --property env`
+into `$GITHUB_OUTPUT`. Downstream jobs consume the values via `needs.set-version.outputs.*`.
+
+```yaml
+name: CI with job outputs
+
+on:
+  push:
+    branches: [main, "release/*"]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/synacker/git-version-utils:latest
+      options: --workdir /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
+    outputs:
+      BUILD_VERSION: ${{ steps.git_version.outputs.BUILD_VERSION }}
+      BUILD_VERSION_MAJOR: ${{ steps.git_version.outputs.BUILD_VERSION_MAJOR }}
+      BUILD_VERSION_MINOR: ${{ steps.git_version.outputs.BUILD_VERSION_MINOR }}
+      BUILD_VERSION_PATCH: ${{ steps.git_version.outputs.BUILD_VERSION_PATCH }}
+      BUILD_VERSION_BUILD: ${{ steps.git_version.outputs.BUILD_VERSION_BUILD }}
+      BUILD_VERSION_TAG: ${{ steps.git_version.outputs.BUILD_VERSION_TAG }}
+      BUILD_VERSION_FULL: ${{ steps.git_version.outputs.BUILD_VERSION_FULL }}
+      BUILD_VERSION_EXTENDED: ${{ steps.git_version.outputs.BUILD_VERSION_EXTENDED }}
+      BUILD_VERSION_SHORT: ${{ steps.git_version.outputs.BUILD_VERSION_SHORT }}
+      BUILD_VERSION_COMMIT: ${{ steps.git_version.outputs.BUILD_VERSION_COMMIT }}
+      BUILD_VERSION_BRANCH: ${{ steps.git_version.outputs.BUILD_VERSION_BRANCH }}
+      BUILD_VERSION_DEFAULT_BRANCH: ${{ steps.git_version.outputs.BUILD_VERSION_DEFAULT_BRANCH }}
+      BUILD_VERSION_RELEASE_BRANCHES: ${{ steps.git_version.outputs.BUILD_VERSION_RELEASE_BRANCHES }}
+
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+
+      - name: Extract version info
+        id: git_version
+        run: |
+          while IFS='=' read -r key value; do
+            echo "$key=$value" >> "$GITHUB_OUTPUT"
+          done < <(git-version --property env)
+
+  build:
+    runs-on: ubuntu-latest
+    needs: set-version
+    steps:
+      - uses: actions/checkout@v6.0.3
+
+      - name: Use version info
+        run: |
+          echo "Building version: ${{ needs.set-version.outputs.BUILD_VERSION }}"
+          echo "Tag: ${{ needs.set-version.outputs.BUILD_VERSION_TAG }}"
+```
+
+### GitHub Actions — Env File Artifact
+
+A simpler approach: write the version info to a file and share it as an artifact.
+
+```yaml
+name: CI with env file
+
+on:
+  push:
+    branches: [main, "release/*"]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/synacker/git-version-utils:latest
+      options: --workdir /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+
+      - name: Generate version.env
+        run: git-version --property env > version.env
+
+      - name: Upload version env file
+        uses: actions/upload-artifact@v4
+        with:
+          name: version-env
+          path: version.env
+
+  build:
+    runs-on: ubuntu-latest
+    needs: set-version
+    steps:
+      - uses: actions/checkout@v6.0.3
+
+      - name: Download version env file
+        uses: actions/download-artifact@v4
+        with:
+          name: version-env
+
+      - name: Load version and use it
+        run: |
+          source version.env
+          echo "Building version: $BUILD_VERSION"
+          echo "Tag: $BUILD_VERSION_TAG"
+```
+
+### GitLab CI
+
+Use the image directly and share version info via
+[dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv).
+
+```yaml
+stages:
+  - set-version
+  - build
+
+set-version:
+  stage: set-version
+  image: ghcr.io/synacker/git-version-utils:latest
+  variables:
+    GIT_DEPTH: 0
+  script:
+    - git-version --property env > version.env
+  artifacts:
+    reports:
+      dotenv: version.env
+
+build:
+  stage: build
+  image: python:3.13-slim
+  needs:
+    - job: set-version
+      artifacts: true
+  script:
+    - echo "Building version: $BUILD_VERSION"
+    - echo "Tag: $BUILD_VERSION_TAG"

{git_version_utils-0.1.0.0 → git_version_utils-0.2.0.0}/src/git_version/_version.py

@@ -1,4 +1,4 @@
 # file generated by tools/write_version.py
 # don't change, don't track in version control
-__version__ = "0.1.0.0"
-__version_tuple__ = (0, 1, 0, 0)
+__version__ = "0.2.0.0"
+__version_tuple__ = (0, 2, 0, 0)

{git_version_utils-0.1.0.0 → git_version_utils-0.2.0.0}/src/git_version/cli.py

@@ -22,6 +22,12 @@ def main() -> None:
         default="v[0-9]*",
         help="Glob pattern to match version tags (default: v[0-9]*)",
     )
+    parser.add_argument(
+        "--safe-directory",
+        default=None,
+        help="Pass ``-c safe.directory=<value>`` to git commands. "
+             "Use ``'*'`` to allow all directories (useful in Docker containers).",
+    )
     parser.add_argument(
         "--property", "-P",
         choices=[
@@ -34,7 +40,11 @@ def main() -> None:
     )
     args = parser.parse_args()
 
-    gv = GitVersion(repo_path=args.repo, tag_pattern=args.tag_pattern)
+    gv = GitVersion(
+        repo_path=args.repo,
+        tag_pattern=args.tag_pattern,
+        safe_directory=args.safe_directory,
+    )
 
     if args.property == "env":
         for key, value in gv.env(prefix=args.prefix).items():

{git_version_utils-0.1.0.0 → git_version_utils-0.2.0.0}/src/git_version/core.py

@@ -13,6 +13,8 @@ class GitVersion:
         tag_pattern: Glob pattern to match version tags (default: "v[0-9]*").
         release_branches: List of branch patterns considered as release branches.
             Defaults to [default_branch, "release/*"].
+        safe_directory: Pass ``-c safe.directory=<value>`` to every git command.
+            Use ``"*"`` to allow all directories (useful in Docker containers).
     """
 
     def __init__(
@@ -20,16 +22,22 @@ class GitVersion:
         repo_path: str | None = None,
         tag_pattern: str = "v[0-9]*",
         release_branches: list[str] | None = None,
+        safe_directory: str | None = None,
     ):
         self.repo_path = os.path.abspath(repo_path or os.getcwd())
         self.tag_pattern = tag_pattern
         self._release_branches = release_branches
+        self._safe_directory = safe_directory
 
     def _git(self, *args: str) -> str:
         """Execute a git command safely and return stripped stdout."""
         try:
+            cmd = ["git", "-C", self.repo_path]
+            if self._safe_directory is not None:
+                cmd.extend(["-c", f"safe.directory={self._safe_directory}"])
+            cmd.extend(args)
             result = subprocess.run(
-                ["git", "-C", self.repo_path, *args],
+                cmd,
                 capture_output=True,
                 text=True,
                 check=True,

git_version_utils-0.2.0.0/src/git_version_utils.egg-info/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: git-version-utils
+Version: 0.2.0.0
+Summary: Extract version information from a Git repository and output as environment variables
+Author-email: Mikhail Milovidov <synacker@yandex.ru>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/synacker/git_version_utils
+Project-URL: Repository, https://github.com/synacker/git_version_utils
+Keywords: git,version,build,ci,cd
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# git-version-utils
+
+Extract version information from a Git repository and output as environment variables.
+
+## Installation
+
+```bash
+pip install git-version-utils
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Print all version info
+git-version
+
+# Output as environment variables (useful with `source` or `eval`)
+git-version --property env
+
+# Custom prefix for environment variables
+git-version --prefix MYAPP --property env
+
+# Custom tag pattern
+git-version --tag-pattern "release-*" --property env
+
+# Get a single property
+git-version --property version
+git-version --property version_major
+git-version --property commit
+
+# Specify repository path
+git-version --repo /path/to/repo --property env
+```
+
+### Python API
+
+```python
+from git_version import GitVersion
+
+gv = GitVersion(repo_path="/path/to/repo", tag_pattern="v[0-9]*")
+
+print(gv.version)       # "1.2.3.42"
+print(gv.version_major) # "1"
+print(gv.version_minor) # "2"
+print(gv.version_patch) # "3"
+print(gv.build)         # "42"
+print(gv.tag)           # "v1.2.3"
+print(gv.branch)        # "main"
+print(gv.short)         # "a1b2c3"
+print(gv.full)          # "1.2.3.42-a1b2c3"
+print(gv.commit)        # "a1b2c3d4e5f6..."
+
+# Get all as environment variables
+env_vars = gv.env(prefix="BUILD_VERSION")
+for key, value in env_vars.items():
+    print(f"{key}={value}")
+```
+
+## Environment Variables Output
+
+With default prefix `BUILD_VERSION`:
+
+| Variable | Example | Description |
+|---|---|---|
+| `BUILD_VERSION` | `1.2.3.42` | Full version: `<semver>.<build>` |
+| `BUILD_VERSION_MAJOR` | `1` | Major version component |
+| `BUILD_VERSION_MINOR` | `2` | Minor version component |
+| `BUILD_VERSION_PATCH` | `3` | Patch version component |
+| `BUILD_VERSION_BUILD` | `42` | Commits since last tag |
+| `BUILD_VERSION_TAG` | `v1.2.3` | Latest matching git tag |
+| `BUILD_VERSION_FULL` | `1.2.3.42-a1b2c3` | Version with commit hash |
+| `BUILD_VERSION_EXTENDED` | `1.2.3.42-a1b2c3` | Full if build>0, else version |
+| `BUILD_VERSION_SHORT` | `a1b2c3` | Short 6-char commit hash |
+| `BUILD_VERSION_COMMIT` | `a1b2c3d4...` | Full 40-char commit hash |
+| `BUILD_VERSION_BRANCH` | `main` | Current branch name |
+| `BUILD_VERSION_DEFAULT_BRANCH` | `master` | Default branch from git config |
+
+## CI/CD Integration
+
+### Shell (source)
+
+```bash
+source <(git-version --property env)
+echo "$BUILD_VERSION"
+```
+
+### CMake
+
+```cmake
+execute_process(
+    COMMAND git-version --property env
+    OUTPUT_VARIABLE GIT_VERSION_ENV
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+```
+
+### Docker
+
+```dockerfile
+RUN pip install git-version-utils
+RUN source <(git-version --property env) && echo "Building $BUILD_VERSION"
+```
+
+## Docker CI Container
+
+A pre-built Docker image with `git-version-utils` is available at
+`ghcr.io/synacker/git-version-utils`.
+
+The image is based on `python:3.13-slim` and includes `git` + `git-version-utils`.
+It is designed to be used as the **job container** in CI pipelines.
+
+### Usage
+
+```bash
+# Run git-version inside the container
+docker run --rm \
+  -v $(pwd):/workspace -w /workspace \
+  ghcr.io/synacker/git-version-utils:latest \
+  git-version --safe-directory '*' --property env
+```
+
+### GitHub Actions — Job Outputs
+
+Use `container:` to run the job inside the image, then parse `git-version --property env`
+into `$GITHUB_OUTPUT`. Downstream jobs consume the values via `needs.set-version.outputs.*`.
+
+```yaml
+name: CI with job outputs
+
+on:
+  push:
+    branches: [main, "release/*"]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/synacker/git-version-utils:latest
+      options: --workdir /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
+    outputs:
+      BUILD_VERSION: ${{ steps.git_version.outputs.BUILD_VERSION }}
+      BUILD_VERSION_MAJOR: ${{ steps.git_version.outputs.BUILD_VERSION_MAJOR }}
+      BUILD_VERSION_MINOR: ${{ steps.git_version.outputs.BUILD_VERSION_MINOR }}
+      BUILD_VERSION_PATCH: ${{ steps.git_version.outputs.BUILD_VERSION_PATCH }}
+      BUILD_VERSION_BUILD: ${{ steps.git_version.outputs.BUILD_VERSION_BUILD }}
+      BUILD_VERSION_TAG: ${{ steps.git_version.outputs.BUILD_VERSION_TAG }}
+      BUILD_VERSION_FULL: ${{ steps.git_version.outputs.BUILD_VERSION_FULL }}
+      BUILD_VERSION_EXTENDED: ${{ steps.git_version.outputs.BUILD_VERSION_EXTENDED }}
+      BUILD_VERSION_SHORT: ${{ steps.git_version.outputs.BUILD_VERSION_SHORT }}
+      BUILD_VERSION_COMMIT: ${{ steps.git_version.outputs.BUILD_VERSION_COMMIT }}
+      BUILD_VERSION_BRANCH: ${{ steps.git_version.outputs.BUILD_VERSION_BRANCH }}
+      BUILD_VERSION_DEFAULT_BRANCH: ${{ steps.git_version.outputs.BUILD_VERSION_DEFAULT_BRANCH }}
+      BUILD_VERSION_RELEASE_BRANCHES: ${{ steps.git_version.outputs.BUILD_VERSION_RELEASE_BRANCHES }}
+
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+
+      - name: Extract version info
+        id: git_version
+        run: |
+          while IFS='=' read -r key value; do
+            echo "$key=$value" >> "$GITHUB_OUTPUT"
+          done < <(git-version --property env)
+
+  build:
+    runs-on: ubuntu-latest
+    needs: set-version
+    steps:
+      - uses: actions/checkout@v6.0.3
+
+      - name: Use version info
+        run: |
+          echo "Building version: ${{ needs.set-version.outputs.BUILD_VERSION }}"
+          echo "Tag: ${{ needs.set-version.outputs.BUILD_VERSION_TAG }}"
+```
+
+### GitHub Actions — Env File Artifact
+
+A simpler approach: write the version info to a file and share it as an artifact.
+
+```yaml
+name: CI with env file
+
+on:
+  push:
+    branches: [main, "release/*"]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/synacker/git-version-utils:latest
+      options: --workdir /__w/${{ github.event.repository.name }}/${{ github.event.repository.name }}
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+
+      - name: Generate version.env
+        run: git-version --property env > version.env
+
+      - name: Upload version env file
+        uses: actions/upload-artifact@v4
+        with:
+          name: version-env
+          path: version.env
+
+  build:
+    runs-on: ubuntu-latest
+    needs: set-version
+    steps:
+      - uses: actions/checkout@v6.0.3
+
+      - name: Download version env file
+        uses: actions/download-artifact@v4
+        with:
+          name: version-env
+
+      - name: Load version and use it
+        run: |
+          source version.env
+          echo "Building version: $BUILD_VERSION"
+          echo "Tag: $BUILD_VERSION_TAG"
+```
+
+### GitLab CI
+
+Use the image directly and share version info via
+[dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv).
+
+```yaml
+stages:
+  - set-version
+  - build
+
+set-version:
+  stage: set-version
+  image: ghcr.io/synacker/git-version-utils:latest
+  variables:
+    GIT_DEPTH: 0
+  script:
+    - git-version --property env > version.env
+  artifacts:
+    reports:
+      dotenv: version.env
+
+build:
+  stage: build
+  image: python:3.13-slim
+  needs:
+    - job: set-version
+      artifacts: true
+  script:
+    - echo "Building version: $BUILD_VERSION"
+    - echo "Tag: $BUILD_VERSION_TAG"

git_version_utils-0.1.0.0/PKG-INFO

@@ -1,115 +0,0 @@
-Metadata-Version: 2.4
-Name: git-version-utils
-Version: 0.1.0.0
-Summary: Extract version information from a Git repository and output as environment variables
-Author-email: Mikhail Milovidov <synacker@yandex.ru>
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/synacker/git_version_utils
-Project-URL: Repository, https://github.com/synacker/git_version_utils
-Keywords: git,version,build,ci,cd
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-
-# git-version-utils
-
-Extract version information from a Git repository and output as environment variables.
-
-## Installation
-
-```bash
-pip install git-version-utils
-```
-
-## Usage
-
-### CLI
-
-```bash
-# Print all version info
-git-version
-
-# Output as environment variables (useful with `source` or `eval`)
-git-version --property env
-
-# Custom prefix for environment variables
-git-version --prefix MYAPP --property env
-
-# Custom tag pattern
-git-version --tag-pattern "release-*" --property env
-
-# Get a single property
-git-version --property version
-git-version --property version_major
-git-version --property commit
-
-# Specify repository path
-git-version --repo /path/to/repo --property env
-```
-
-### Python API
-
-```python
-from git_version import GitVersion
-
-gv = GitVersion(repo_path="/path/to/repo", tag_pattern="v[0-9]*")
-
-print(gv.version)       # "1.2.3.42"
-print(gv.version_major) # "1"
-print(gv.version_minor) # "2"
-print(gv.version_patch) # "3"
-print(gv.build)         # "42"
-print(gv.tag)           # "v1.2.3"
-print(gv.branch)        # "main"
-print(gv.short)         # "a1b2c3"
-print(gv.full)          # "1.2.3.42-a1b2c3"
-print(gv.commit)        # "a1b2c3d4e5f6..."
-
-# Get all as environment variables
-env_vars = gv.env(prefix="BUILD_VERSION")
-for key, value in env_vars.items():
-    print(f"{key}={value}")
-```
-
-## Environment Variables Output
-
-With default prefix `BUILD_VERSION`:
-
-| Variable | Example | Description |
-|---|---|---|
-| `BUILD_VERSION` | `1.2.3.42` | Full version: `<semver>.<build>` |
-| `BUILD_VERSION_MAJOR` | `1` | Major version component |
-| `BUILD_VERSION_MINOR` | `2` | Minor version component |
-| `BUILD_VERSION_PATCH` | `3` | Patch version component |
-| `BUILD_VERSION_BUILD` | `42` | Commits since last tag |
-| `BUILD_VERSION_TAG` | `v1.2.3` | Latest matching git tag |
-| `BUILD_VERSION_FULL` | `1.2.3.42-a1b2c3` | Version with commit hash |
-| `BUILD_VERSION_EXTENDED` | `1.2.3.42-a1b2c3` | Full if build>0, else version |
-| `BUILD_VERSION_SHORT` | `a1b2c3` | Short 6-char commit hash |
-| `BUILD_VERSION_COMMIT` | `a1b2c3d4...` | Full 40-char commit hash |
-| `BUILD_VERSION_BRANCH` | `main` | Current branch name |
-| `BUILD_VERSION_DEFAULT_BRANCH` | `master` | Default branch from git config |
-
-## CI/CD Integration
-
-### Shell (source)
-
-```bash
-source <(git-version --property env)
-echo "$BUILD_VERSION"
-```
-
-### CMake
-
-```cmake
-execute_process(
-    COMMAND git-version --property env
-    OUTPUT_VARIABLE GIT_VERSION_ENV
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-)
-```
-
-### Docker
-
-```dockerfile
-RUN pip install git-version-utils
-RUN source <(git-version --property env) && echo "Building $BUILD_VERSION"

git_version_utils-0.1.0.0/README.md

@@ -1,103 +0,0 @@
-# git-version-utils
-
-Extract version information from a Git repository and output as environment variables.
-
-## Installation
-
-```bash
-pip install git-version-utils
-```
-
-## Usage
-
-### CLI
-
-```bash
-# Print all version info
-git-version
-
-# Output as environment variables (useful with `source` or `eval`)
-git-version --property env
-
-# Custom prefix for environment variables
-git-version --prefix MYAPP --property env
-
-# Custom tag pattern
-git-version --tag-pattern "release-*" --property env
-
-# Get a single property
-git-version --property version
-git-version --property version_major
-git-version --property commit
-
-# Specify repository path
-git-version --repo /path/to/repo --property env
-```
-
-### Python API
-
-```python
-from git_version import GitVersion
-
-gv = GitVersion(repo_path="/path/to/repo", tag_pattern="v[0-9]*")
-
-print(gv.version)       # "1.2.3.42"
-print(gv.version_major) # "1"
-print(gv.version_minor) # "2"
-print(gv.version_patch) # "3"
-print(gv.build)         # "42"
-print(gv.tag)           # "v1.2.3"
-print(gv.branch)        # "main"
-print(gv.short)         # "a1b2c3"
-print(gv.full)          # "1.2.3.42-a1b2c3"
-print(gv.commit)        # "a1b2c3d4e5f6..."
-
-# Get all as environment variables
-env_vars = gv.env(prefix="BUILD_VERSION")
-for key, value in env_vars.items():
-    print(f"{key}={value}")
-```
-
-## Environment Variables Output
-
-With default prefix `BUILD_VERSION`:
-
-| Variable | Example | Description |
-|---|---|---|
-| `BUILD_VERSION` | `1.2.3.42` | Full version: `<semver>.<build>` |
-| `BUILD_VERSION_MAJOR` | `1` | Major version component |
-| `BUILD_VERSION_MINOR` | `2` | Minor version component |
-| `BUILD_VERSION_PATCH` | `3` | Patch version component |
-| `BUILD_VERSION_BUILD` | `42` | Commits since last tag |
-| `BUILD_VERSION_TAG` | `v1.2.3` | Latest matching git tag |
-| `BUILD_VERSION_FULL` | `1.2.3.42-a1b2c3` | Version with commit hash |
-| `BUILD_VERSION_EXTENDED` | `1.2.3.42-a1b2c3` | Full if build>0, else version |
-| `BUILD_VERSION_SHORT` | `a1b2c3` | Short 6-char commit hash |
-| `BUILD_VERSION_COMMIT` | `a1b2c3d4...` | Full 40-char commit hash |
-| `BUILD_VERSION_BRANCH` | `main` | Current branch name |
-| `BUILD_VERSION_DEFAULT_BRANCH` | `master` | Default branch from git config |
-
-## CI/CD Integration
-
-### Shell (source)
-
-```bash
-source <(git-version --property env)
-echo "$BUILD_VERSION"
-```
-
-### CMake
-
-```cmake
-execute_process(
-    COMMAND git-version --property env
-    OUTPUT_VARIABLE GIT_VERSION_ENV
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-)
-```
-
-### Docker
-
-```dockerfile
-RUN pip install git-version-utils
-RUN source <(git-version --property env) && echo "Building $BUILD_VERSION"

git_version_utils-0.1.0.0/src/git_version_utils.egg-info/PKG-INFO

@@ -1,115 +0,0 @@
-Metadata-Version: 2.4
-Name: git-version-utils
-Version: 0.1.0.0
-Summary: Extract version information from a Git repository and output as environment variables
-Author-email: Mikhail Milovidov <synacker@yandex.ru>
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/synacker/git_version_utils
-Project-URL: Repository, https://github.com/synacker/git_version_utils
-Keywords: git,version,build,ci,cd
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-
-# git-version-utils
-
-Extract version information from a Git repository and output as environment variables.
-
-## Installation
-
-```bash
-pip install git-version-utils
-```
-
-## Usage
-
-### CLI
-
-```bash
-# Print all version info
-git-version
-
-# Output as environment variables (useful with `source` or `eval`)
-git-version --property env
-
-# Custom prefix for environment variables
-git-version --prefix MYAPP --property env
-
-# Custom tag pattern
-git-version --tag-pattern "release-*" --property env
-
-# Get a single property
-git-version --property version
-git-version --property version_major
-git-version --property commit
-
-# Specify repository path
-git-version --repo /path/to/repo --property env
-```
-
-### Python API
-
-```python
-from git_version import GitVersion
-
-gv = GitVersion(repo_path="/path/to/repo", tag_pattern="v[0-9]*")
-
-print(gv.version)       # "1.2.3.42"
-print(gv.version_major) # "1"
-print(gv.version_minor) # "2"
-print(gv.version_patch) # "3"
-print(gv.build)         # "42"
-print(gv.tag)           # "v1.2.3"
-print(gv.branch)        # "main"
-print(gv.short)         # "a1b2c3"
-print(gv.full)          # "1.2.3.42-a1b2c3"
-print(gv.commit)        # "a1b2c3d4e5f6..."
-
-# Get all as environment variables
-env_vars = gv.env(prefix="BUILD_VERSION")
-for key, value in env_vars.items():
-    print(f"{key}={value}")
-```
-
-## Environment Variables Output
-
-With default prefix `BUILD_VERSION`:
-
-| Variable | Example | Description |
-|---|---|---|
-| `BUILD_VERSION` | `1.2.3.42` | Full version: `<semver>.<build>` |
-| `BUILD_VERSION_MAJOR` | `1` | Major version component |
-| `BUILD_VERSION_MINOR` | `2` | Minor version component |
-| `BUILD_VERSION_PATCH` | `3` | Patch version component |
-| `BUILD_VERSION_BUILD` | `42` | Commits since last tag |
-| `BUILD_VERSION_TAG` | `v1.2.3` | Latest matching git tag |
-| `BUILD_VERSION_FULL` | `1.2.3.42-a1b2c3` | Version with commit hash |
-| `BUILD_VERSION_EXTENDED` | `1.2.3.42-a1b2c3` | Full if build>0, else version |
-| `BUILD_VERSION_SHORT` | `a1b2c3` | Short 6-char commit hash |
-| `BUILD_VERSION_COMMIT` | `a1b2c3d4...` | Full 40-char commit hash |
-| `BUILD_VERSION_BRANCH` | `main` | Current branch name |
-| `BUILD_VERSION_DEFAULT_BRANCH` | `master` | Default branch from git config |
-
-## CI/CD Integration
-
-### Shell (source)
-
-```bash
-source <(git-version --property env)
-echo "$BUILD_VERSION"
-```
-
-### CMake
-
-```cmake
-execute_process(
-    COMMAND git-version --property env
-    OUTPUT_VARIABLE GIT_VERSION_ENV
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-)
-```
-
-### Docker
-
-```dockerfile
-RUN pip install git-version-utils
-RUN source <(git-version --property env) && echo "Building $BUILD_VERSION"