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

gha_utils/__init__.py

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

gha_utils/changelog.py

@@ -19,6 +19,7 @@ from __future__ import annotations
 import logging
 import re
 import sys
+from functools import cached_property
 from pathlib import Path
 from textwrap import indent
 
@@ -38,10 +39,20 @@ class Changelog:
             self.content = initial_changelog
         logging.debug(f"Initial content set to:\n{self.content}")
 
-    def update(self) -> str | None:
+    @cached_property
+    def current_version(self) -> str | None:
+        # 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"))
+        current_version = config["tool"]["bumpversion"]["current_version"]
+        logging.info(f"Current version: {current_version}")
+        return current_version if current_version else None
+
+    def update(self) -> str:
         r"""Adds a new empty entry at the top of the changelog.
 
-        Returns ``None`` if initial changelog content has already been updated.
+        Will return the same content as the current changelog if it has already been updated.
 
         This is designed to be used just after a new release has been tagged. And before a
         post-release version increment is applied with a call to:
@@ -98,16 +109,6 @@ class Changelog:
         Would not tag since we are not committing
         ```
         """
-        # 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"))
-        current_version = config["tool"]["bumpversion"]["current_version"]
-        logging.info(f"Current version: {current_version}")
-        assert current_version
-
-        assert current_version in self.content
-
         # Extract parts of the changelog or set default values.
         SECTION_START = "##"
         sections = self.content.split(SECTION_START, 2)
@@ -125,7 +126,7 @@ class Changelog:
         # Update GitHub's comparison URL to target the main branch.
         new_entry = re.sub(
             rf"v{VERSION_REGEX}\.\.\.v{VERSION_REGEX}",
-            f"v{current_version}...main",
+            f"v{self.current_version}...main",
             new_entry,
             count=1,
         )
@@ -141,12 +142,9 @@ class Changelog:
             new_entry,
             flags=re.MULTILINE | re.DOTALL,
         )
-        new_entry = f"{SECTION_START}{new_entry}"
         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}"
+        history = current_entry + past_entries
+        if new_entry not in history:
+            history = new_entry + history
+        return (changelog_header + history).rstrip()

gha_utils/cli.py

@@ -187,7 +187,7 @@ def changelog(ctx, source, changelog_path):
 
     changelog = Changelog(initial_content)
     content = changelog.update()
-    if not content:
+    if content == initial_content:
         logging.warning("Changelog already up to date. Do nothing.")
         ctx.exit()
 

gha_utils/metadata.py

@@ -398,11 +398,13 @@ class Metadata:
             current_version = Metadata.get_current_version()
 
             sha_list.append(commit.hash)
-            include_list.append({
-                "commit": commit.hash,
-                "short_sha": commit.hash[:SHORT_SHA_LENGTH],
-                "current_version": current_version,
-            })
+            include_list.append(
+                {
+                    "commit": commit.hash,
+                    "short_sha": commit.hash[:SHORT_SHA_LENGTH],
+                    "current_version": current_version,
+                }
+            )
 
         # Restore the repository to its initial state.
         if past_commit_lookup:
@@ -412,10 +414,12 @@ class Metadata:
                 logging.debug("Unstash local changes that were previously saved.")
                 git.repo.git.stash("pop")
 
-        return Matrix({
-            "commit": sha_list,
-            "include": include_list,
-        })
+        return Matrix(
+            {
+                "commit": sha_list,
+                "include": include_list,
+            }
+        )
 
     @cached_property
     def event_type(self) -> WorkflowEvent | None:  # type: ignore[valid-type]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gha-utils
-Version: 4.5.1
+Version: 4.5.3
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -54,6 +54,13 @@ Requires-Dist: pyproject-metadata ~=0.8.0
 Requires-Dist: wcmatch >=8.5
 Requires-Dist: backports.strenum ~=1.3.1 ; python_version < "3.11"
 Requires-Dist: tomli ~=2.0.1 ; python_version < "3.11"
+Provides-Extra: test
+Requires-Dist: coverage[toml] ~=7.6.0 ; extra == 'test'
+Requires-Dist: pytest ~=8.3.1 ; extra == 'test'
+Requires-Dist: pytest-cases ~=3.8.3 ; extra == 'test'
+Requires-Dist: pytest-cov ~=5.0.0 ; extra == 'test'
+Requires-Dist: pytest-github-actions-annotate-failures ~=0.2.0 ; extra == 'test'
+Requires-Dist: pytest-randomly ~=3.15.0 ; extra == 'test'
 
 # `gha-utils` CLI + reusable workflows
 
@@ -61,6 +68,7 @@ Requires-Dist: tomli ~=2.0.1 ; python_version < "3.11"
 [![Python versions](https://img.shields.io/pypi/pyversions/gha-utils.svg)](https://pypi.python.org/pypi/gha-utils)
 [![Type checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Unittests status](https://github.com/kdeldycke/workflows/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/kdeldycke/workflows/actions/workflows/tests.yaml?query=branch%3Amain)
+[![Coverage status](https://codecov.io/gh/kdeldycke/workflows/branch/main/graph/badge.svg)](https://app.codecov.io/gh/kdeldycke/workflows)
 
 Thanks to this project, I am able to **release Python packages multiple times a day with only 2-clicks**.
 

gha_utils-4.5.3.dist-info/RECORD

@@ -0,0 +1,12 @@
+gha_utils/__init__.py,sha256=nwJF-TNbGW0vPLIN9UbZJNTT83fXwRXiy1v5k6dKAl4,865
+gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
+gha_utils/changelog.py,sha256=oahY88A9FRV14f1JSFKIiYrN_TS7Jo3QlljXqJbeuaE,5892
+gha_utils/cli.py,sha256=f1NRPffvgl5waBau8-5twXO7n3By_797npWBR_22XoM,9217
+gha_utils/mailmap.py,sha256=snSQBn1BDZ21783l4yCkQc3RLIxh5X6QCunFRkDj-24,6301
+gha_utils/metadata.py,sha256=MhFzNlx5nE2Z9DI89yPsloik-JL40_yBzO-K1Ly5Vn8,47283
+gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gha_utils-4.5.3.dist-info/METADATA,sha256=CV0NUhzAl7k_A9a3IG-tmcyYT5MPajuMeTcBugOZIH4,18485
+gha_utils-4.5.3.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
+gha_utils-4.5.3.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
+gha_utils-4.5.3.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
+gha_utils-4.5.3.dist-info/RECORD,,

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

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

gha_utils-4.5.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-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,,