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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.21.0
+Version: 4.22.0
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -50,7 +50,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Requires-Dist: boltons>=24.0.0
 Requires-Dist: bump-my-version<1.1.1,>=0.32.2
-Requires-Dist: click-extra~=6.0.0
+Requires-Dist: click-extra~=6.0.2
 Requires-Dist: extra-platforms~=3.2.0
 Requires-Dist: packaging~=25.0
 Requires-Dist: py-walk~=0.3.3

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

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

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

@@ -31,6 +31,7 @@ yaml_files="config.yaml" ".github/workflows/lint.yaml" ".github/workflows/test.y
 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"
+image_files=
 zsh_files=
 is_python_project=true
 package_name=click-extra
@@ -736,7 +737,7 @@ class Metadata:
         return False
 
     @cached_property
-    def commit_range(self) -> tuple[str, str] | None:
+    def commit_range(self) -> tuple[str | None, str] | None:
         """Range of commits bundled within the triggering event.
 
         A workflow run is triggered by a singular event, which might encapsulate one or
@@ -783,7 +784,7 @@ class Metadata:
             end = self.github_context["event"]["pull_request"]["head"]["sha"]
         # Push event.
         else:
-            start = self.github_context["event"]["before"]
+            start = self.github_context["event"].get("before")
             end = os.environ["GITHUB_SHA"]
             assert end
         logging.debug(f"Commit range: {start} -> {end}")
@@ -811,6 +812,8 @@ class Metadata:
         # 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):
+            if not commit_id:
+                continue
             try:
                 _ = self.git.get_commit(commit_id)
             except ValueError:
@@ -824,6 +827,11 @@ class Metadata:
                 )
                 return None
 
+        if not start:
+            logging.warning("No start commit found. Only one commit in range.")
+            assert end
+            return (self.git.get_commit(end),)
+
         commit_list = []
         for index, commit in enumerate(
             Repository(".", from_commit=start, to_commit=end).traverse_commits()
@@ -1003,6 +1011,15 @@ class Metadata:
         """Returns a list of Markdown files."""
         return self.glob_files("**/*.{markdown,mdown,mkdn,mdwn,mkd,md,mdtxt,mdtext}")
 
+    @cached_property
+    def image_files(self) -> list[Path]:
+        """Returns a list of image files.
+
+        Inspired by the list of image extensions supported by calibre's image-actions:
+        https://github.com/calibreapp/image-actions/blob/f325757/src/constants.ts#L32
+        """
+        return self.glob_files("**/*.{jpeg,jpg,png,webp,avif}")
+
     @cached_property
     def zsh_files(self) -> list[Path]:
         """Returns a list of Zsh files."""
@@ -1575,6 +1592,7 @@ class Metadata:
             "workflow_files": self.workflow_files,
             "doc_files": self.doc_files,
             "markdown_files": self.markdown_files,
+            "image_files": self.image_files,
             "zsh_files": self.zsh_files,
             "is_python_project": self.is_python_project,
             "package_name": self.package_name,

{gha_utils-4.21.0 → gha_utils-4.22.0}/gha_utils/test_plan.py

@@ -28,7 +28,11 @@ from typing import Generator, Sequence
 import yaml
 from boltons.iterutils import flatten
 from boltons.strutils import strip_ansi
-from click_extra.testing import args_cleanup, render_cli_run
+from click_extra.testing import (
+    args_cleanup,
+    regex_fullmatch_line_by_line,
+    render_cli_run,
+)
 from extra_platforms import Group, _TNestedReferences, current_os
 
 
@@ -265,9 +269,7 @@ class CLITestCase:
                         raise AssertionError(f"{name} does not match regex {regex}")
 
             elif field_id.endswith("_regex_fullmatch"):
-                regex = field_data
-                if not regex.fullmatch(output):
-                    raise AssertionError(f"{name} does not fully match regex {regex}")
+                regex_fullmatch_line_by_line(field_data, output)
 
 
 DEFAULT_TEST_PLAN: list[CLITestCase] = [

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.21.0
+Version: 4.22.0
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -50,7 +50,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Requires-Dist: boltons>=24.0.0
 Requires-Dist: bump-my-version<1.1.1,>=0.32.2
-Requires-Dist: click-extra~=6.0.0
+Requires-Dist: click-extra~=6.0.2
 Requires-Dist: extra-platforms~=3.2.0
 Requires-Dist: packaging~=25.0
 Requires-Dist: py-walk~=0.3.3

{gha_utils-4.21.0 → gha_utils-4.22.0}/gha_utils.egg-info/requires.txt

@@ -1,6 +1,6 @@
 boltons>=24.0.0
 bump-my-version<1.1.1,>=0.32.2
-click-extra~=6.0.0
+click-extra~=6.0.2
 extra-platforms~=3.2.0
 packaging~=25.0
 py-walk~=0.3.3

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

@@ -1,7 +1,7 @@
 [project]
 # Docs: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 name = "gha-utils"
-version = "4.21.0"
+version = "4.22.0"
 # Python versions and their status: https://devguide.python.org/versions/
 requires-python = ">= 3.11"
 description = "⚙️ CLI helpers for GitHub Actions + reuseable workflows"
@@ -78,8 +78,8 @@ dependencies = [
     # v0.32.2 is the first fixing an issue preventing compilation with Nuitka.
     # v1.1.1 and later have some regressions: see https://github.com/callowayproject/bump-my-version/issues/331
     "bump-my-version >= 0.32.2, < 1.1.1",
-    # Click Extra 6.0.0 fix an isue with --version option.
-    "click-extra ~= 6.0.0",
+    # Click Extra 6.0.2 adds a new regex_fullmatch_line_by_line() function we rely on.
+    "click-extra ~= 6.0.2",
     "extra-platforms ~= 3.2.0",
     "packaging ~= 25.0",
     # In the future, replace py-walk with wcmatch once the latter supports gitignore files:
@@ -146,7 +146,7 @@ addopts = [
 xfail_strict = true
 
 [tool.bumpversion]
-current_version = "4.21.0"
+current_version = "4.22.0"
 allow_dirty = true
 ignore_missing_files = true
 

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

@@ -163,6 +163,9 @@ expected = {
         "changelog.md",
         "readme.md",
     ],
+    "image_files": [
+        "docs/assets/repo-workflow-permissions.png",
+    ],
     "zsh_files": [],
     "is_python_project": True,
     "package_name": "gha-utils",