gha-utils 4.20.0__tar.gz → 4.21.0__tar.gz

{gha_utils-4.20.0 → gha_utils-4.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.20.0
+Version: 4.21.0
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows

{gha_utils-4.20.0 → gha_utils-4.21.0}/gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.20.0"
+__version__ = "4.21.0"

{gha_utils-4.20.0 → gha_utils-4.21.0}/gha_utils/cli.py

@@ -239,9 +239,9 @@ def changelog(ctx, source, changelog_path):
     "--create-if-missing/--skip-if-missing",
     is_flag=True,
     default=True,
-    help="Create the destination mailmap file if it is not found. Or skip the update "
-    "process entirely if if does not already exists in the first place. This option "
-    f"is ignore if the destination is to print the result to {sys.stdout.name}.",
+    help="If not found, either create the missing destination mailmap file, or skip "
+    "the update process entirely. This option is ignored if the destination is to print "
+    f"the result to {sys.stdout.name}.",
 )
 @argument(
     "destination_mailmap",

{gha_utils-4.20.0 → gha_utils-4.21.0}/gha_utils/metadata.py

@@ -23,9 +23,15 @@ The following variables are `printed to the environment file
 is_bot=false
 new_commits=346ce664f055fbd042a25ee0b7e96702e95 6f27db47612aaee06fdf08744b09a9f5f6c2
 release_commits=6f27db47612aaee06fdf08744b09a9f5f6c2
+mailmap_exists=true
 gitignore_exists=true
 python_files=".github/update_mailmap.py" ".github/metadata.py" "setup.py"
+json_files=
+yaml_files="config.yaml" ".github/workflows/lint.yaml" ".github/workflows/test.yaml"
+workflow_files=".github/workflows/lint.yaml" ".github/workflows/test.yaml"
 doc_files="changelog.md" "readme.md" "docs/license.md"
+markdown_files="changelog.md" "readme.md" "docs/license.md"
+zsh_files=
 is_python_project=true
 package_name=click-extra
 blacken_docs_params=--target-version py37 --target-version py38
@@ -80,14 +86,14 @@ build_targets=[
     },
     {
         "target": "macos-arm64",
-        "os": "macos-15",
+        "os": "macos-26",
         "platform_id": "macos",
         "arch": "arm64",
         "extension": "bin"
     },
     {
         "target": "macos-x64",
-        "os": "macos-13",
+        "os": "macos-15-intel",
         "platform_id": "macos",
         "arch": "x64",
         "extension": "bin"
@@ -111,8 +117,8 @@ nuitka_matrix={
     "os": [
         "ubuntu-24.04-arm",
         "ubuntu-24.04",
-        "macos-15",
-        "macos-13",
+        "macos-26",
+        "macos-15-intel",
         "windows-11-arm",
         "windows-2025"
     ],
@@ -138,14 +144,14 @@ nuitka_matrix={
         },
         {
             "target": "macos-arm64",
-            "os": "macos-15",
+            "os": "macos-26",
             "platform_id": "macos",
             "arch": "arm64",
             "extension": "bin"
         },
         {
             "target": "macos-x64",
-            "os": "macos-13",
+            "os": "macos-15-intel",
             "platform_id": "macos",
             "arch": "x64",
             "extension": "bin"
@@ -206,25 +212,25 @@ nuitka_matrix={
             "bin_name": "mpm-linux-x64-6f27db4.bin"
         },
         {
-            "os": "macos-15",
+            "os": "macos-26",
             "entry_point": "mpm",
             "commit": "346ce664f055fbd042a25ee0b7e96702e95",
             "bin_name": "mpm-macos-arm64-346ce66.bin"
         },
         {
-            "os": "macos-15",
+            "os": "macos-26",
             "entry_point": "mpm",
             "commit": "6f27db47612aaee06fdf08744b09a9f5f6c2",
             "bin_name": "mpm-macos-arm64-6f27db4.bin"
         },
         {
-            "os": "macos-13",
+            "os": "macos-15-intel",
             "entry_point": "mpm",
             "commit": "346ce664f055fbd042a25ee0b7e96702e95",
             "bin_name": "mpm-macos-x64-346ce66.bin"
         },
         {
-            "os": "macos-13",
+            "os": "macos-15-intel",
             "entry_point": "mpm",
             "commit": "6f27db47612aaee06fdf08744b09a9f5f6c2",
             "bin_name": "mpm-macos-x64-6f27db4.bin"
@@ -288,6 +294,7 @@ from extra_platforms import is_github_ci
 from packaging.specifiers import SpecifierSet
 from packaging.version import Version
 from py_walk import get_parser_from_file
+from py_walk.models import Parser
 from pydriller import Commit, Git, Repository  # type: ignore[import-untyped]
 from pyproject_metadata import ConfigurationError, StandardMetadata
 from wcmatch.glob import (
@@ -312,6 +319,8 @@ SHORT_SHA_LENGTH = 7
     depends on the size of the repository.
 """
 
+MAILMAP_PATH = Path(".mailmap")
+
 GITIGNORE_PATH = Path(".gitignore")
 
 NUITKA_BUILD_TARGETS = {
@@ -328,13 +337,13 @@ NUITKA_BUILD_TARGETS = {
         "extension": "bin",
     },
     "macos-arm64": {
-        "os": "macos-15",
+        "os": "macos-26",
         "platform_id": "macos",
         "arch": "arm64",
         "extension": "bin",
     },
     "macos-x64": {
-        "os": "macos-13",
+        "os": "macos-15-intel",
         "platform_id": "macos",
         "arch": "x64",
         "extension": "bin",
@@ -472,6 +481,10 @@ MYPY_VERSION_MIN: Final = (3, 8)
 """
 
 
+# Silence overly verbose debug messages from py-walk logger.
+logging.getLogger("py_walk").setLevel(logging.WARNING)
+
+
 class JSONMetadata(json.JSONEncoder):
     """Custom JSON encoder for metadata serialization."""
 
@@ -531,10 +544,15 @@ class Metadata:
         logging.debug(json.dumps(context, indent=4))
         return context  # type:ignore[no-any-return]
 
-    def git_stash_count(self, git_repo: Git) -> int:
+    @cached_property
+    def git(self) -> Git:
+        """Return a PyDriller Git object."""
+        return Git(".")
+
+    def git_stash_count(self) -> int:
         """Returns the number of stashes."""
         count = int(
-            git_repo.repo.git.rev_list(
+            self.git.repo.git.rev_list(
                 "--walk-reflogs", "--ignore-missing", "--count", "refs/stash"
             )
         )
@@ -579,8 +597,7 @@ class Metadata:
         if not commits:
             return None
 
-        git = Git(".")
-        current_commit = git.repo.head.commit.hexsha
+        current_commit = self.git.repo.head.commit.hexsha
 
         # Check if we need to get back in time in the Git log and browse past commits.
         if len(commits) == 1:  # type: ignore[arg-type]
@@ -608,17 +625,17 @@ class Metadata:
             # Save the initial commit reference and SHA of the repository. The
             # reference is either the canonical active branch name (i.e. ``main``), or
             # the commit SHA if the current HEAD commit is detached from a branch.
-            if git.repo.head.is_detached:
+            if self.git.repo.head.is_detached:
                 init_ref = current_commit
             else:
-                init_ref = git.repo.active_branch.name
+                init_ref = self.git.repo.active_branch.name
             logging.debug(f"Initial commit reference: {init_ref}")
 
             # Try to stash local changes and check if we'll need to unstash them later.
-            counter_before = self.git_stash_count(git)
+            counter_before = self.git_stash_count()
             logging.debug("Try to stash local changes before our series of checkouts.")
-            git.repo.git.stash()
-            counter_after = self.git_stash_count(git)
+            self.git.repo.git.stash()
+            counter_after = self.git_stash_count()
             logging.debug(
                 "Stash counter changes after 'git stash' command: "
                 f"{counter_before} -> {counter_after}"
@@ -639,7 +656,7 @@ class Metadata:
         for commit in commits:
             if past_commit_lookup:
                 logging.debug(f"Checkout to commit {commit.hash}")
-                git.checkout(commit.hash)
+                self.git.checkout(commit.hash)
 
             commit_metadata = {
                 "commit": commit.hash,
@@ -657,10 +674,10 @@ class Metadata:
         # Restore the repository to its initial state.
         if past_commit_lookup:
             logging.debug(f"Restore repository to {init_ref}.")
-            git.checkout(init_ref)
+            self.git.checkout(init_ref)
             if need_unstash:
                 logging.debug("Unstash local changes that were previously saved.")
-                git.repo.git.stash("pop")
+                self.git.repo.git.stash("pop")
 
         return matrix
 
@@ -788,15 +805,34 @@ class Metadata:
         if not self.commit_range:
             return None
         start, end = self.commit_range
-        # Remove the last commit, as the commit range is inclusive.
-        return tuple(
-            Repository(
-                ".",
-                from_commit=start,
-                to_commit=end,
-                order="reverse",
-            ).traverse_commits(),
-        )[:-1]
+
+        # Sanity check: make sure the start commit exists in the repository.
+        # XXX Even if we skip the start commit later on (because the range is
+        # inclusive), we still need to make sure it exists: PyDriller stills needs to
+        # find it to be able to traverse the commit history.
+        for commit_id in (start, end):
+            try:
+                _ = self.git.get_commit(commit_id)
+            except ValueError:
+                logging.error(
+                    f"Cannot find commit {commit_id} in repository. "
+                    "Repository was probably not checked out with enough depth. "
+                    f"Current depth is {self.git.total_commits()}. "
+                )
+                logging.warning(
+                    "Skipping metadata extraction of the range of new commits."
+                )
+                return None
+
+        commit_list = []
+        for index, commit in enumerate(
+            Repository(".", from_commit=start, to_commit=end).traverse_commits()
+        ):
+            # Skip the first commit because the commit range is inclusive.
+            if index == 0:
+                continue
+            commit_list.append(commit)
+        return tuple(commit_list)
 
     @cached_property
     def new_commits_matrix(self) -> Matrix | None:
@@ -845,10 +881,27 @@ class Metadata:
             else None
         )
 
+    @cached_property
+    def mailmap_exists(self) -> bool:
+        return MAILMAP_PATH.is_file()
+
     @cached_property
     def gitignore_exists(self) -> bool:
         return GITIGNORE_PATH.is_file()
 
+    @cached_property
+    def gitignore_parser(self) -> Parser | None:
+        """Returns a parser for the ``.gitignore`` file, if it exists."""
+        if self.gitignore_exists:
+            logging.debug(f"Parse {GITIGNORE_PATH}")
+            return get_parser_from_file(GITIGNORE_PATH)
+        return None
+
+    def gitignore_match(self, file_path: Path | str) -> bool:
+        if self.gitignore_parser and self.gitignore_parser.match(file_path):
+            return True
+        return False
+
     def glob_files(self, *patterns: str) -> list[Path]:
         """Return all file path matching the ``patterns``.
 
@@ -878,12 +931,6 @@ class Metadata:
         current_dir = Path.cwd()
         seen = set()
 
-        # If the .gitignore file exists, we parse it to filter out ignored files.
-        gitignore = None
-        if self.gitignore_exists:
-            logging.debug(f"Load {GITIGNORE_PATH} to filter out ignored files.")
-            gitignore = get_parser_from_file(GITIGNORE_PATH)
-
         for file_path in iglob(
             patterns,
             flags=NODIR | GLOBSTAR | DOTGLOB | GLOBTILDE | BRACE | FOLLOW | NEGATE,
@@ -913,7 +960,7 @@ class Metadata:
                 continue
 
             # Skip files that are ignored by .gitignore.
-            if gitignore and gitignore.match(file_path):
+            if self.gitignore_match(file_path):
                 logging.debug(f"Skip file matching {GITIGNORE_PATH}: {file_path}")
                 continue
 
@@ -934,6 +981,16 @@ class Metadata:
             "!**/package-lock.json",
         )
 
+    @cached_property
+    def yaml_files(self) -> list[Path]:
+        """Returns a list of YAML files."""
+        return self.glob_files("**/*.{yaml,yml}")
+
+    @cached_property
+    def workflow_files(self) -> list[Path]:
+        """Returns a list of GitHub workflow files."""
+        return self.glob_files(".github/workflows/**/*.{yaml,yml}")
+
     @cached_property
     def doc_files(self) -> list[Path]:
         """Returns a list of doc files."""
@@ -1194,8 +1251,8 @@ class Metadata:
                 "os": [
                     "ubuntu-24.04-arm",
                     "ubuntu-24.04",
-                    "macos-15",
-                    "macos-13",
+                    "macos-26",
+                    "macos-15-intel",
                     "windows-11-arm",
                     "windows-2025",
                 ],
@@ -1223,14 +1280,14 @@ class Metadata:
                     },
                     {
                         "target": "macos-arm64",
-                        "os": "macos-15",
+                        "os": "macos-26",
                         "platform_id": "macos",
                         "arch": "arm64",
                         "extension": "bin",
                     },
                     {
                         "target": "macos-x64",
-                        "os": "macos-13",
+                        "os": "macos-15-intel",
                         "platform_id": "macos",
                         "arch": "x64",
                         "extension": "bin",
@@ -1291,25 +1348,25 @@ class Metadata:
                         "bin_name": "mpm-linux-x64-6f27db4.bin",
                     },
                     {
-                        "os": "macos-15",
+                        "os": "macos-26",
                         "entry_point": "mpm",
                         "commit": "346ce664f055fbd042a25ee0b7e96702e95",
                         "bin_name": "mpm-macos-arm64-346ce66.bin",
                     },
                     {
-                        "os": "macos-15",
+                        "os": "macos-26",
                         "entry_point": "mpm",
                         "commit": "6f27db47612aaee06fdf08744b09a9f5f6c2",
                         "bin_name": "mpm-macos-arm64-6f27db4.bin",
                     },
                     {
-                        "os": "macos-13",
+                        "os": "macos-15-intel",
                         "entry_point": "mpm",
                         "commit": "346ce664f055fbd042a25ee0b7e96702e95",
                         "bin_name": "mpm-macos-x64-346ce66.bin",
                     },
                     {
-                        "os": "macos-13",
+                        "os": "macos-15-intel",
                         "entry_point": "mpm",
                         "commit": "6f27db47612aaee06fdf08744b09a9f5f6c2",
                         "bin_name": "mpm-macos-x64-6f27db4.bin",
@@ -1510,9 +1567,12 @@ class Metadata:
             "is_bot": self.is_bot,
             "new_commits": self.new_commits_hash,
             "release_commits": self.release_commits_hash,
+            "mailmap_exists": self.mailmap_exists,
             "gitignore_exists": self.gitignore_exists,
             "python_files": self.python_files,
             "json_files": self.json_files,
+            "yaml_files": self.yaml_files,
+            "workflow_files": self.workflow_files,
             "doc_files": self.doc_files,
             "markdown_files": self.markdown_files,
             "zsh_files": self.zsh_files,

{gha_utils-4.20.0 → gha_utils-4.21.0}/gha_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.20.0
+Version: 4.21.0
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows

{gha_utils-4.20.0 → gha_utils-4.21.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 # Docs: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 name = "gha-utils"
-version = "4.20.0"
+version = "4.21.0"
 # Python versions and their status: https://devguide.python.org/versions/
 requires-python = ">= 3.11"
 description = "⚙️ CLI helpers for GitHub Actions + reuseable workflows"
@@ -115,6 +115,8 @@ gha-utils = "gha_utils.__main__:main"
 
 [tool.uv]
 package = true
+# 0.9.0 is the snapshot version we used when we migrated from requirements/uv.txt to pyproject.toml.
+required-version = "~= 0.9.0"
 
 [tool.mypy]
 warn_unused_configs = true
@@ -144,7 +146,7 @@ addopts = [
 xfail_strict = true
 
 [tool.bumpversion]
-current_version = "4.20.0"
+current_version = "4.21.0"
 allow_dirty = true
 ignore_missing_files = true
 

{gha_utils-4.20.0 → gha_utils-4.21.0}/tests/test_metadata.py

@@ -71,6 +71,16 @@ def iter_checks(metadata: Any, expected: Any, context: Any) -> None:
         assert isinstance(metadata, dict)
         assert set(metadata) == set(expected)
         for key, value in expected.items():
+            # By convention, keys ending with "_files" are path strings so they need to
+            # be adjusted for Windows.
+            if key.endswith("_files") and is_windows():
+                # Path are stored as a list in JSON format.
+                if isinstance(value, list):
+                    value = [v.replace("/", "\\") for v in value]
+                # Path are space-separated and serialized as a string in GitHub format.
+                else:
+                    value = value.replace("/", "\\")
+
             iter_checks(metadata[key], value, metadata)
 
     elif isinstance(expected, list):
@@ -90,24 +100,9 @@ expected = {
     "is_bot": False,
     "new_commits": None,
     "release_commits": None,
+    "mailmap_exists": True,
     "gitignore_exists": True,
     "python_files": [
-        "gha_utils\\__init__.py",
-        "gha_utils\\__main__.py",
-        "gha_utils\\changelog.py",
-        "gha_utils\\cli.py",
-        "gha_utils\\mailmap.py",
-        "gha_utils\\matrix.py",
-        "gha_utils\\metadata.py",
-        "gha_utils\\test_plan.py",
-        "tests\\__init__.py",
-        "tests\\test_changelog.py",
-        "tests\\test_mailmap.py",
-        "tests\\test_matrix.py",
-        "tests\\test_metadata.py",
-    ]
-    if is_windows()
-    else [
         "gha_utils/__init__.py",
         "gha_utils/__main__.py",
         "gha_utils/changelog.py",
@@ -123,24 +118,47 @@ expected = {
         "tests/test_metadata.py",
     ],
     "json_files": [],
+    "yaml_files": [
+        ".github/dependabot.yaml",
+        ".github/funding.yml",
+        ".github/labeller-content-based.yaml",
+        ".github/labeller-file-based.yaml",
+        ".github/labels-awesome.yaml",
+        ".github/labels.yaml",
+        ".github/workflows/autofix.yaml",
+        ".github/workflows/autolock.yaml",
+        ".github/workflows/changelog.yaml",
+        ".github/workflows/debug.yaml",
+        ".github/workflows/docs.yaml",
+        ".github/workflows/label-sponsors.yaml",
+        ".github/workflows/labeller-content-based.yaml",
+        ".github/workflows/labeller-file-based.yaml",
+        ".github/workflows/labels.yaml",
+        ".github/workflows/lint.yaml",
+        ".github/workflows/release.yaml",
+        ".github/workflows/tests.yaml",
+        "tests/cli-test-plan.yaml",
+    ],
+    "workflow_files": [
+        ".github/workflows/autofix.yaml",
+        ".github/workflows/autolock.yaml",
+        ".github/workflows/changelog.yaml",
+        ".github/workflows/debug.yaml",
+        ".github/workflows/docs.yaml",
+        ".github/workflows/label-sponsors.yaml",
+        ".github/workflows/labeller-content-based.yaml",
+        ".github/workflows/labeller-file-based.yaml",
+        ".github/workflows/labels.yaml",
+        ".github/workflows/lint.yaml",
+        ".github/workflows/release.yaml",
+        ".github/workflows/tests.yaml",
+    ],
     "doc_files": [
-        ".github\\code-of-conduct.md",
-        "changelog.md",
-        "readme.md",
-    ]
-    if is_windows()
-    else [
         ".github/code-of-conduct.md",
         "changelog.md",
         "readme.md",
     ],
     "markdown_files": [
-        ".github\\code-of-conduct.md",
-        "changelog.md",
-        "readme.md",
-    ]
-    if is_windows()
-    else [
         ".github/code-of-conduct.md",
         "changelog.md",
         "readme.md",
@@ -184,14 +202,14 @@ expected = {
         },
         {
             "target": "macos-arm64",
-            "os": "macos-15",
+            "os": "macos-26",
             "platform_id": "macos",
             "arch": "arm64",
             "extension": "bin",
         },
         {
             "target": "macos-x64",
-            "os": "macos-13",
+            "os": "macos-15-intel",
             "platform_id": "macos",
             "arch": "x64",
             "extension": "bin",
@@ -215,8 +233,8 @@ expected = {
         "os": [
             "ubuntu-24.04-arm",
             "ubuntu-24.04",
-            "macos-15",
-            "macos-13",
+            "macos-26",
+            "macos-15-intel",
             "windows-11-arm",
             "windows-2025",
         ],
@@ -239,14 +257,14 @@ expected = {
             },
             {
                 "target": "macos-arm64",
-                "os": "macos-15",
+                "os": "macos-26",
                 "platform_id": "macos",
                 "arch": "arm64",
                 "extension": "bin",
             },
             {
                 "target": "macos-x64",
-                "os": "macos-13",
+                "os": "macos-15-intel",
                 "platform_id": "macos",
                 "arch": "x64",
                 "extension": "bin",
@@ -290,13 +308,13 @@ expected = {
                 "bin_name": regex(r"gha-utils-linux-x64-[a-z0-9]+\.bin"),
             },
             {
-                "os": "macos-15",
+                "os": "macos-26",
                 "entry_point": "gha-utils",
                 "commit": regex(r"[a-z0-9]+"),
                 "bin_name": regex(r"gha-utils-macos-arm64-[a-z0-9]+\.bin"),
             },
             {
-                "os": "macos-13",
+                "os": "macos-15-intel",
                 "entry_point": "gha-utils",
                 "commit": regex(r"[a-z0-9]+"),
                 "bin_name": regex(r"gha-utils-macos-x64-[a-z0-9]+\.bin"),