gha-utils 4.16.3__tar.gz → 4.16.4__tar.gz

{gha_utils-4.16.3 → gha_utils-4.16.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.16.3
+Version: 4.16.4
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -46,8 +46,8 @@ 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~=4.15.0
-Requires-Dist: extra-platforms~=3.1.0
+Requires-Dist: click-extra~=5.0.0
+Requires-Dist: extra-platforms~=3.2.0
 Requires-Dist: packaging~=25.0
 Requires-Dist: PyDriller~=2.6
 Requires-Dist: pyproject-metadata~=0.9.0

{gha_utils-4.16.3 → gha_utils-4.16.4}/gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.16.3"
+__version__ = "4.16.4"

{gha_utils-4.16.3 → gha_utils-4.16.4}/gha_utils/cli.py

@@ -38,7 +38,7 @@ from click_extra import (
     pass_context,
 )
 from click_extra.envvar import merge_envvar_ids
-from extra_platforms import ALL_IDS
+from extra_platforms import ALL_IDS, is_github_ci
 
 from . import __version__
 from .changelog import Changelog
@@ -156,7 +156,7 @@ def metadata(ctx, format, overwrite, output_path):
     metadata = Metadata()
 
     # Output a warning in GitHub runners if metadata are not saved to $GITHUB_OUTPUT.
-    if metadata.in_ci_env:
+    if is_github_ci():
         env_file = os.getenv("GITHUB_OUTPUT")
         if env_file and Path(env_file) != output_path:
             logging.warning(

{gha_utils-4.16.3 → gha_utils-4.16.4}/gha_utils/mailmap.py

@@ -25,7 +25,7 @@ from subprocess import run
 from boltons.iterutils import unique
 
 
-@dataclass(order=True, frozen=True)
+@dataclass(order=True)
 class Record:
     """A mailmap identity mapping entry."""
 
@@ -35,6 +35,11 @@ class Record:
     aliases: set[str] = field(default_factory=set)
     pre_comment: str = ""
 
+    def __post_init__(self) -> None:
+        """Empty pre-comment are normalized to empty string, even if they are multi-lines."""
+        if self.pre_comment.strip() == "":
+            self.pre_comment = ""
+
     def __str__(self) -> str:
         """Render the record with pre-comments first, followed by the identity mapping.
 
@@ -58,7 +63,11 @@ class Mailmap:
     <https://git-scm.com/docs/gitmailmap>`_.
     """
 
-    records: list[Record] = list()
+    records: list[Record]
+
+    def __init__(self) -> None:
+        """Initialize the mailmap with an empty list of records."""
+        self.records = []
 
     @staticmethod
     def split_identities(mapping: str) -> tuple[str, set[str]]:
@@ -161,6 +170,15 @@ class Mailmap:
 
     def render(self) -> str:
         """Render internal records in Mailmap format."""
-        return "\n".join(
+        # Extract the pre-comment from the first record, if any, so we can keep it
+        # attached to the top of the file.
+        top_comment = self.records[0].pre_comment if self.records else ""
+        if top_comment:
+            top_comment += "\n"
+            # Reset the pre-comment of the first record, so it doesn't get duplicated
+            # in the output.
+            self.records[0].pre_comment = ""
+
+        return top_comment + "\n".join(
             map(str, sorted(self.records, key=lambda r: r.canonical.casefold()))
         )

{gha_utils-4.16.3 → gha_utils-4.16.4}/gha_utils/metadata.py

@@ -173,6 +173,7 @@ from typing import Any, Final, Iterator, cast
 from bumpversion.config import get_configuration  # type: ignore[import-untyped]
 from bumpversion.config.files import find_config_file  # type: ignore[import-untyped]
 from bumpversion.show import resolve_name  # type: ignore[import-untyped]
+from extra_platforms import is_github_ci
 from packaging.specifiers import SpecifierSet
 from packaging.version import Version
 from pydriller import Commit, Git, Repository  # type: ignore[import-untyped]
@@ -291,15 +292,6 @@ class Metadata:
     pyproject_path = Path() / "pyproject.toml"
     sphinx_conf_path = Path() / "docs" / "conf.py"
 
-    @cached_property
-    def in_ci_env(self) -> bool:
-        """Returns ``True`` if the code is executed in a GitHub Actions runner.
-
-        Other CI are available at:
-        https://github.com/cucumber/ci-environment/blob/main/python/src/ci_environment/CiEnvironments.json
-        """
-        return bool("GITHUB_RUN_ID" in os.environ)
-
     @cached_property
     def github_context(self) -> dict[str, Any]:
         """Load GitHub context from the environment.
@@ -321,7 +313,7 @@ class Metadata:
             JSON/env hack above.
         """
         if "GITHUB_CONTEXT" not in os.environ:
-            if self.in_ci_env:
+            if is_github_ci():
                 message = (
                     "Missing GitHub context in environment. "
                     "Did you forget to set GITHUB_CONTEXT?"
@@ -401,7 +393,7 @@ class Metadata:
                 "We need to look into the commit history. Inspect the initial state of the repository."
             )
 
-            if not self.in_ci_env:
+            if not is_github_ci():
                 raise RuntimeError(
                     "Local repository manipulations only allowed in CI environment"
                 )
@@ -476,7 +468,7 @@ class Metadata:
         .. todo::
             Add detection of all workflow trigger events.
         """
-        if not self.in_ci_env:
+        if not is_github_ci():
             logging.warning(
                 "Cannot guess event type because we're not in a CI environment."
             )

{gha_utils-4.16.3 → gha_utils-4.16.4}/gha_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.16.3
+Version: 4.16.4
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -46,8 +46,8 @@ 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~=4.15.0
-Requires-Dist: extra-platforms~=3.1.0
+Requires-Dist: click-extra~=5.0.0
+Requires-Dist: extra-platforms~=3.2.0
 Requires-Dist: packaging~=25.0
 Requires-Dist: PyDriller~=2.6
 Requires-Dist: pyproject-metadata~=0.9.0

{gha_utils-4.16.3 → gha_utils-4.16.4}/gha_utils.egg-info/requires.txt

@@ -1,7 +1,7 @@
 boltons>=24.0.0
 bump-my-version<1.1.1,>=0.32.2
-click-extra~=4.15.0
-extra-platforms~=3.1.0
+click-extra~=5.0.0
+extra-platforms~=3.2.0
 packaging~=25.0
 PyDriller~=2.6
 pyproject-metadata~=0.9.0

{gha_utils-4.16.3 → gha_utils-4.16.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 # Docs: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 name = "gha-utils"
-version = "4.16.3"
+version = "4.16.4"
 # Python versions and their status: https://devguide.python.org/versions/
 requires-python = ">= 3.11"
 description = "⚙️ CLI helpers for GitHub Actions + reuseable workflows"
@@ -74,8 +74,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 ~= 4.15.0",
-    "extra-platforms ~= 3.1.0",
+    "click-extra ~= 5.0.0",
+    "extra-platforms ~= 3.2.0",
     "packaging ~= 25.0",
     "PyDriller ~= 2.6",
     "pyproject-metadata ~= 0.9.0",
@@ -137,7 +137,7 @@ addopts = [
 xfail_strict = true
 
 [tool.bumpversion]
-current_version = "4.16.3"
+current_version = "4.16.4"
 allow_dirty = true
 ignore_missing_files = true
 

{gha_utils-4.16.3 → gha_utils-4.16.4}/tests/test_mailmap.py

@@ -19,7 +19,7 @@ from __future__ import annotations
 from textwrap import dedent
 
 from gha_utils.cli import remove_header
-from gha_utils.mailmap import Mailmap
+from gha_utils.mailmap import Mailmap, Record
 
 
 def test_remove_header():
@@ -67,7 +67,50 @@ def test_mailmap():
         GitHub <noreply@github.com>
         GitHub <noreply@github.com> dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
         GitHub <noreply@github.com>
+        github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> GitHub Actions <actions@github.com>"""
+    )
 
 
-        github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> GitHub Actions <actions@github.com>"""
+def test_new_entry():
+    mailmap = Mailmap()
+
+    header = dedent(
+        """\
+        # Generated by gha-utils mailmap-sync v4.16.2 - https://github.com/kdeldycke/workflows
+        # Timestamp: 2025-05-13T13:14:51.128939
+        # Format is:
+        #   Preferred Name <preferred e-mail> Other Name <other e-mail>
+        #
+        # Reference: https://git-scm.com/docs/git-blame#_mapping_authors"""
+    )
+
+    mailmap.parse(
+        dedent(
+            f"""\
+            {header}
+            dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+
+
+            """
+        )
+    )
+
+    assert len(mailmap.records) == 1
+    assert (
+        mailmap.records[0].canonical
+        == "dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>"
+    )
+    assert mailmap.records[0].aliases == set()
+    assert mailmap.records[0].pre_comment == header
+
+    # Add new record manually
+    new_contributor = "AA BB <aa@bb.example.org>"
+    mailmap.records.append(Record(canonical=new_contributor))
+
+    assert mailmap.render() == (
+        header
+        + "\n"
+        + new_contributor
+        + "\n"
+        + "dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>"
     )