gha-utils 4.5.0__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.5.0"
+__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
@@ -136,7 +136,7 @@ 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,

gha_utils/cli.py

@@ -21,6 +21,7 @@ import os
 import sys
 from datetime import datetime
 from pathlib import Path
+from typing import IO
 
 from click_extra import (
     Choice,
@@ -41,13 +42,18 @@ from .metadata import Dialects, Metadata
 
 
 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) == "-"
 
 
-def handle_stdout(filepath: Path) -> Path | None:
+def prep_path(filepath: Path) -> IO | None:
+    """Prepare the output file parameter for Click's echo function."""
     if is_stdout(filepath):
         return None
-    return filepath
+    return filepath.open("w", encoding="UTF-8")
 
 
 def generate_header(ctx: Context) -> str:
@@ -157,7 +163,7 @@ def metadata(ctx, format, overwrite, output_path):
 
     dialect = Dialects(format)
     content = metadata.dump(dialect=dialect)
-    echo(content, file=handle_stdout(output_path))
+    echo(content, file=prep_path(output_path))
 
 
 @gha_utils.command(short_help="Maintain a Markdown-formatted changelog")
@@ -189,7 +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}")
-    echo(content, file=handle_stdout(changelog_path))
+    echo(content, file=prep_path(changelog_path))
 
 
 @gha_utils.command(short_help="Update Git's .mailmap file with missing contributors")
@@ -263,4 +269,4 @@ def mailmap_sync(ctx, source, create_if_missing, destination_mailmap):
             logging.warning("Nothing to update, stop the sync process.")
             ctx.exit()
 
-    echo(generate_header(ctx) + new_content, file=handle_stdout(destination_mailmap))
+    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

@@ -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.5.0.dist-info → gha_utils-4.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gha-utils
-Version: 4.5.0
+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

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.5.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-gha_utils/__init__.py,sha256=2hpwFw1Fxf-LQg9Elgz4VZow1ivxy9LI5LEfSKa3mQY,865
-gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
-gha_utils/changelog.py,sha256=-Iek7GkoM2MhUVQ_CloQzSMMUvX0TfDLytbDuZmrPRs,5923
-gha_utils/cli.py,sha256=WE8Pi4Ga3S_2cn2u2RT7XC6ngrXhrQE4UnFwNOPW6Ec,8976
-gha_utils/mailmap.py,sha256=sum4XIme2Dis7XtHyO9U7ogWelZwqb-yvJ5I92PPnqg,6301
-gha_utils/metadata.py,sha256=FLkNjjAlB3FieMgvbtBQwWnA7tE6APEGnGHgbe8gbZg,47203
-gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gha_utils-4.5.0.dist-info/METADATA,sha256=HfmzzdwWWdQ6kyXh0T_rsTJIZdK9KMZMemCaTg8CnHs,17976
-gha_utils-4.5.0.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
-gha_utils-4.5.0.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
-gha_utils-4.5.0.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
-gha_utils-4.5.0.dist-info/RECORD,,