gha-utils 4.4.5__py3-none-any.whl → 4.5.1__py3-none-any.whl

gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.4.5"
+__version__ = "4.5.1"

gha_utils/changelog.py

@@ -69,14 +69,14 @@ class Changelog:
 
         ! ## [2.17.5 (unreleased)](https://github.com/kdeldycke/workflows/compare/v2.17.4...main)
 
-          > \[!IMPORTANT\]
+          > [!IMPORTANT]
           > This version is not released yet and is under active development.
         --- 1,6 ----
           # Changelog
 
         ! ## [2.17.6 (unreleased)](https://github.com/kdeldycke/workflows/compare/v2.17.4...main)
 
-          > \[!IMPORTANT\]
+          > [!IMPORTANT]
           > This version is not released yet and is under active development.
         Would write to config file pyproject.toml:
         *** before pyproject.toml
@@ -101,7 +101,7 @@ class Changelog:
         # Extract current version as defined by bump-my-version.
         config_file = Path("./pyproject.toml").resolve()
         logging.info(f"Open {config_file}")
-        config = tomllib.loads(config_file.read_text(encoding="utf-8"))
+        config = tomllib.loads(config_file.read_text(encoding="UTF-8"))
         current_version = config["tool"]["bumpversion"]["current_version"]
         logging.info(f"Current version: {current_version}")
         assert current_version
@@ -112,15 +112,15 @@ class Changelog:
         SECTION_START = "##"
         sections = self.content.split(SECTION_START, 2)
         changelog_header = sections[0] if len(sections) > 0 else "# Changelog\n\n"
-        recent_entry = sections[1] if len(sections) > 1 else ""
-        past_entries = sections[2] if len(sections) > 2 else ""
+        current_entry = f"{SECTION_START}{sections[1]}" if len(sections) > 1 else ""
+        past_entries = f"{SECTION_START}{sections[2]}" if len(sections) > 2 else ""
 
         # Derive the release template from the last entry.
         DATE_REGEX = r"\d{4}\-\d{2}\-\d{2}"
         VERSION_REGEX = r"\d+\.\d+\.\d+"
 
         # Replace the release date with the unreleased tag.
-        new_entry = re.sub(DATE_REGEX, "unreleased", recent_entry, count=1)
+        new_entry = re.sub(DATE_REGEX, "unreleased", current_entry, count=1)
 
         # Update GitHub's comparison URL to target the main branch.
         new_entry = re.sub(
@@ -136,21 +136,17 @@ class Changelog:
         new_entry = re.sub(
             r"\n\n.*",
             "\n\n"
-            "> \\[!IMPORTANT\\]\n"
+            "> [!IMPORTANT]\n"
             "> This version is not released yet and is under active development.\n\n",
             new_entry,
             flags=re.MULTILINE | re.DOTALL,
         )
-
-        # Prefix entries with section marker.
         new_entry = f"{SECTION_START}{new_entry}"
-        history = f"{SECTION_START}{recent_entry}{SECTION_START}{past_entries}"
-
         logging.info("New generated section:\n" + indent(new_entry, " " * 2))
 
         # No need to update.
+        history = f"{current_entry}{past_entries}"
         if new_entry in history:
             return None
-
         # Recompose full changelog with new top entry.
         return f"{changelog_header}{new_entry}{history}"

gha_utils/cli.py

@@ -19,14 +19,15 @@ from __future__ import annotations
 import logging
 import os
 import sys
-from contextlib import contextmanager
 from datetime import datetime
 from pathlib import Path
+from typing import IO
 
 from click_extra import (
     Choice,
     Context,
     argument,
+    echo,
     extra_group,
     file_path,
     option,
@@ -40,20 +41,19 @@ from .mailmap import Mailmap
 from .metadata import Dialects, Metadata
 
 
-def is_stdout(filepath):
+def is_stdout(filepath: Path) -> bool:
+    """Check if a file path is set to stdout.
+
+    Prevents the creation of a ``-`` file in the current directory.
+    """
     return str(filepath) == "-"
 
 
-@contextmanager
-def file_writer(filepath):
-    """A context-aware file writer which default to stdout if no path is
-    provided."""
+def prep_path(filepath: Path) -> IO | None:
+    """Prepare the output file parameter for Click's echo function."""
     if is_stdout(filepath):
-        yield sys.stdout
-    else:
-        writer = filepath.open("w")
-        yield writer
-        writer.close()
+        return None
+    return filepath.open("w", encoding="UTF-8")
 
 
 def generate_header(ctx: Context) -> str:
@@ -78,10 +78,12 @@ def remove_header(content: str) -> str:
         if still_in_header:
             # We are still in the header as long as we have blank lines or we have
             # comment lines matching the format produced by the method above.
-            if not line.strip() or line.startswith((
-                "# Generated by ",
-                "# Timestamp: ",
-            )):
+            if not line.strip() or line.startswith(
+                (
+                    "# Generated by ",
+                    "# Timestamp: ",
+                )
+            ):
                 continue
             else:
                 still_in_header = False
@@ -161,9 +163,7 @@ def metadata(ctx, format, overwrite, output_path):
 
     dialect = Dialects(format)
     content = metadata.dump(dialect=dialect)
-
-    with file_writer(output_path) as f:
-        f.write(content)
+    echo(content, file=prep_path(output_path))
 
 
 @gha_utils.command(short_help="Maintain a Markdown-formatted changelog")
@@ -183,7 +183,7 @@ def changelog(ctx, source, changelog_path):
     initial_content = None
     if source:
         logging.info(f"Read initial changelog from {source}")
-        initial_content = source.read_text(encoding="utf-8")
+        initial_content = source.read_text(encoding="UTF-8")
 
     changelog = Changelog(initial_content)
     content = changelog.update()
@@ -195,9 +195,7 @@ def changelog(ctx, source, changelog_path):
         logging.info(f"Print updated results to {sys.stdout.name}")
     else:
         logging.info(f"Save updated results to {changelog_path}")
-
-    with file_writer(changelog_path) as f:
-        f.write(content)
+    echo(content, file=prep_path(changelog_path))
 
 
 @gha_utils.command(short_help="Update Git's .mailmap file with missing contributors")
@@ -245,7 +243,7 @@ def mailmap_sync(ctx, source, create_if_missing, destination_mailmap):
 
     if source.exists():
         logging.info(f"Read initial mapping from {source}")
-        content = remove_header(source.read_text(encoding="utf-8"))
+        content = remove_header(source.read_text(encoding="UTF-8"))
         mailmap.parse(content)
     else:
         logging.debug(f"Mailmap source file {source} does not exists.")
@@ -271,5 +269,4 @@ def mailmap_sync(ctx, source, create_if_missing, destination_mailmap):
             logging.warning("Nothing to update, stop the sync process.")
             ctx.exit()
 
-    with file_writer(destination_mailmap) as f:
-        f.write(generate_header(ctx) + new_content)
+    echo(generate_header(ctx) + new_content, file=prep_path(destination_mailmap))

gha_utils/mailmap.py

@@ -131,7 +131,7 @@ class Mailmap:
 
         git_cli = ("git", "log", "--pretty=format:%aN <%aE>%n%cN <%cE>")
         logging.debug(f"Run: {' '.join(git_cli)}")
-        process = run(git_cli, capture_output=True, encoding="utf-8")
+        process = run(git_cli, capture_output=True, encoding="UTF-8")
 
         # Parse git CLI output.
         if process.returncode:

gha_utils/metadata.py

@@ -267,7 +267,7 @@ class Metadata:
               env:
                 GITHUB_CONTEXT: ${{ toJSON(github) }}
               run: |
-                uv --no-progress run gha-utils --verbosity DEBUG metadata --overwrite "$GITHUB_OUTPUT"
+                gha-utils --verbosity DEBUG metadata --overwrite "$GITHUB_OUTPUT"
 
         .. todo::
             Try to remove reliance on GitHub context entirely so we can eliminate the
@@ -626,7 +626,7 @@ class Metadata:
         ``pyproject.toml`` exists and respects the standards. ``False`` otherwise.
         """
         if self.pyproject_path.exists() and self.pyproject_path.is_file():
-            toml = tomllib.loads(self.pyproject_path.read_text(encoding="utf-8"))
+            toml = tomllib.loads(self.pyproject_path.read_text(encoding="UTF-8"))
             try:
                 metadata = StandardMetadata.from_pyproject(toml)
                 self._is_python_project = True
@@ -1104,7 +1104,7 @@ class Metadata:
         changes = ""
         match = re.search(
             rf"^##(?P<title>.+{escape(version)} .+?)\n(?P<changes>.*?)\n##",
-            Path("./changelog.md").read_text(encoding="utf-8"),
+            Path("./changelog.md").read_text(encoding="UTF-8"),
             flags=re.MULTILINE | re.DOTALL,
         )
         if match:

{gha_utils-4.4.5.dist-info → gha_utils-4.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gha-utils
-Version: 4.4.5
+Version: 4.5.1
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -90,11 +90,11 @@ Nothing is done behind your back. A PR is created everytime a change is proposed
 
 Standalone executables of `gha-utils`'s latest version are available as direct downloads for several platforms and architectures:
 
-| Platform          | `x86_64`                                                                                                                         | `arm64`                                                                                                                          |
-| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| **Linux** | [Download `gha-utils-linux-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-linux-x64.bin)     |                                                                                                                                  |
-| **macOS**         | [Download `gha-utils-macos-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-x64.bin)     | [Download `gha-utils-macos-arm64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-arm64.bin) |
-| **Windows**       | [Download `gha-utils-windows-x64.exe`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-windows-x64.exe) |                                                                                                                                  |
+| Platform    | `x86_64`                                                                                                                          | `arm64`                                                                                                                           |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| **Linux**   | [Download `gha-utils-linux-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-linux-x64.bin)     |                                                                                                                                   |
+| **macOS**   | [Download `gha-utils-macos-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-x64.bin)     | [Download `gha-utils-macos-arm64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-arm64.bin) |
+| **Windows** | [Download `gha-utils-windows-x64.exe`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-windows-x64.exe) |                                                                                                                                   |
 
 ### Run dev version
 
@@ -216,7 +216,7 @@ You will always end up with this kind or errors:
   error: failed to push some refs to 'https://github.com/kdeldycke/my-repo'
 ```
 
-> \[!NOTE\]
+> [!NOTE]
 > That's also why the Settings > Actions > General > Workflow permissions parameter on your repository has no effect on this issue, even with the `Read and write permissions` set:
 > ![](docs/assets/repo-workflow-permissions.png)
 
@@ -233,7 +233,7 @@ To create this custom `WORKFLOW_UPDATE_GITHUB_PAT`:
   - `Metadata` (mandatory): `Access: **Read-only**`
   - `Pull Requests`: `Access: **Read and Write**`
   - `Workflows`: `Access: **Read and Write**`
-    > \[!NOTE\]
+    > [!NOTE]
     > This is the only place where I can have control over the `Workflows` permission, which is not supported by the `permissions:` parameter in YAML files.
 - Now save these parameters and copy the `github_pat_XXXX` secret token
 - Got to your repo > `Settings` > `Security` > `Secrets and variables` > `Actions` > `Secrets` > `Repository secrets` and click `New repository secrets`

gha_utils-4.5.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+gha_utils/__init__.py,sha256=Lkof_jh0QHaox_62wIshAQPe0bbkcFTLk6wFZyB7wFY,865
+gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
+gha_utils/changelog.py,sha256=mcIUIce7ATNZyBeZerTWjDKB_mrReFdDJZJyDPIhS3Y,5915
+gha_utils/cli.py,sha256=NlOktO7ddL8fhwkXEB3fVw3Qj-37maWnrYpyL_cKgHw,9202
+gha_utils/mailmap.py,sha256=snSQBn1BDZ21783l4yCkQc3RLIxh5X6QCunFRkDj-24,6301
+gha_utils/metadata.py,sha256=qdhAH-NHPusWIicoN9Js-7idvkcnJa9wzF4mVi7giPY,47203
+gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gha_utils-4.5.1.dist-info/METADATA,sha256=n3ADFMOjC8B5IllUjVzg0eNKzW4lk38-e7gLPcb1JGE,17976
+gha_utils-4.5.1.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+gha_utils-4.5.1.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
+gha_utils-4.5.1.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
+gha_utils-4.5.1.dist-info/RECORD,,

{gha_utils-4.4.5.dist-info → gha_utils-4.5.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.2.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

gha_utils-4.4.5.dist-info/RECORD

@@ -1,12 +0,0 @@
-gha_utils/__init__.py,sha256=QBMQJ3ouEfz5WZFuN6QGlA8qM7VUlElMMuR7YamFzWw,865
-gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
-gha_utils/changelog.py,sha256=KuM323SslStwh25fuEiom39t1kfcgwxHAwi6KNy0Lhk,5959
-gha_utils/cli.py,sha256=4wUG29fB0-Z-n105UBgIg5NLuqtODtoMLwKJP7RQFXo,9150
-gha_utils/mailmap.py,sha256=sum4XIme2Dis7XtHyO9U7ogWelZwqb-yvJ5I92PPnqg,6301
-gha_utils/metadata.py,sha256=d7s3_wlWweIxvv5xvtnKg_ohqojRF8eVBR2U5PxHUlA,47224
-gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gha_utils-4.4.5.dist-info/METADATA,sha256=QKk6F3Y4yLI_W-UFodlLep6_FRjO3ASH_FjDPJSFfVQ,17996
-gha_utils-4.4.5.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
-gha_utils-4.4.5.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
-gha_utils-4.4.5.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
-gha_utils-4.4.5.dist-info/RECORD,,