gha-utils 4.5.2__tar.gz → 4.5.4__tar.gz

{gha_utils-4.5.2 → gha_utils-4.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gha-utils
-Version: 4.5.2
+Version: 4.5.4
 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: PyDriller~=2.6
 Requires-Dist: pyproject-metadata~=0.8.0
 Requires-Dist: tomli~=2.0.1; python_version < "3.11"
 Requires-Dist: wcmatch>=8.5
+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: wcmatch>=8.5
 [![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.2 → gha_utils-4.5.4}/gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.5.2"
+__version__ = "4.5.4"

{gha_utils-4.5.2 → gha_utils-4.5.4}/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,
         )
@@ -143,9 +144,7 @@ class Changelog:
         )
         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-4.5.2 → gha_utils-4.5.4}/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-4.5.2 → gha_utils-4.5.4}/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.2 → gha_utils-4.5.4}/gha_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gha-utils
-Version: 4.5.2
+Version: 4.5.4
 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: PyDriller~=2.6
 Requires-Dist: pyproject-metadata~=0.8.0
 Requires-Dist: tomli~=2.0.1; python_version < "3.11"
 Requires-Dist: wcmatch>=8.5
+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: wcmatch>=8.5
 [![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.2 → gha_utils-4.5.4}/gha_utils.egg-info/SOURCES.txt

@@ -12,4 +12,5 @@ gha_utils.egg-info/SOURCES.txt
 gha_utils.egg-info/dependency_links.txt
 gha_utils.egg-info/entry_points.txt
 gha_utils.egg-info/requires.txt
-gha_utils.egg-info/top_level.txt
+gha_utils.egg-info/top_level.txt
+tests/test_changelog.py

{gha_utils-4.5.2 → gha_utils-4.5.4}/gha_utils.egg-info/requires.txt

@@ -9,3 +9,11 @@ wcmatch>=8.5
 [:python_version < "3.11"]
 backports.strenum~=1.3.1
 tomli~=2.0.1
+
+[test]
+coverage[toml]~=7.6.0
+pytest~=8.3.1
+pytest-cases~=3.8.3
+pytest-cov~=5.0.0
+pytest-github-actions-annotate-failures~=0.2.0
+pytest-randomly~=3.15.0

{gha_utils-4.5.2 → gha_utils-4.5.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 # Docs: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 name = "gha-utils"
-version = "4.5.2"
+version = "4.5.4"
 # Python versions and their status: https://devguide.python.org/versions/
 requires-python = ">= 3.9"
 description = "⚙️ CLI helpers for GitHub Actions + reuseable workflows"
@@ -84,6 +84,17 @@ dependencies = [
     "wcmatch >= 8.5",
 ]
 
+[project.optional-dependencies]
+test = [
+    "coverage [toml] ~= 7.6.0",
+    "pytest ~= 8.3.1",
+    # More pytest plugins at: https://docs.pytest.org/en/latest/reference/plugin_list.html
+    "pytest-cases ~= 3.8.3",
+    "pytest-cov ~= 5.0.0",
+    "pytest-github-actions-annotate-failures ~= 0.2.0",
+    "pytest-randomly ~= 3.15.0",
+]
+
 [project.urls]
 "Homepage" = 'https://github.com/kdeldycke/workflows'
 "Repository" = 'https://github.com/kdeldycke/workflows'
@@ -94,6 +105,9 @@ dependencies = [
 [project.scripts]
 gha-utils = "gha_utils.__main__:main"
 
+[tool.uv]
+package = true
+
 [tool.setuptools.packages.find]
 include = ["gha_utils"]
 
@@ -106,7 +120,7 @@ warn_unreachable = true
 pretty = true
 
 [tool.bumpversion]
-current_version = "4.5.2"
+current_version = "4.5.4"
 allow_dirty = true
 ignore_missing_files = true
 

{gha_utils-4.5.2 → gha_utils-4.5.4}/readme.md

@@ -4,6 +4,7 @@
 [![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.4/tests/test_changelog.py

@@ -0,0 +1,90 @@
+# Copyright Kevin Deldycke <kevin@deldycke.com> and contributors.
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+from __future__ import annotations
+
+from textwrap import dedent
+
+import pytest
+
+from gha_utils.changelog import Changelog
+
+
+@pytest.mark.parametrize(
+    ("version", "initial", "updated"),
+    [
+        ("1.1.1", None, "# Changelog"),
+        ("1.1.1", "", "# Changelog"),
+        (
+            "1.2.1",
+            dedent(
+                """\
+                # Changelog
+
+                ## [1.2.1 (unreleased)](https://github.com/kdeldycke/extra-platforms/compare/v1.2.0...main)
+
+                > [!IMPORTANT]
+                > This version is not released yet and is under active development.
+
+                - Fix changelog indention.
+
+
+                """
+            ),
+            dedent(
+                """\
+                # Changelog
+
+                ## [1.2.1 (unreleased)](https://github.com/kdeldycke/extra-platforms/compare/v1.2.0...main)
+
+                > [!IMPORTANT]
+                > This version is not released yet and is under active development.
+
+                - Fix changelog indention."""
+            ),
+        ),
+        (
+            "1.0.0",
+            dedent(
+                """\
+                # Changelog
+
+                ## [1.0.0 (2024-08-20)](https://github.com/kdeldycke/extra-platforms/compare/v0.0.1...v1.0.0)
+
+                - Add documentation.
+                """
+            ),
+            dedent(
+                """\
+                # Changelog
+
+                ## [1.0.0 (unreleased)](https://github.com/kdeldycke/extra-platforms/compare/v1.0.0...main)
+
+                > [!IMPORTANT]
+                > This version is not released yet and is under active development.
+
+                ## [1.0.0 (2024-08-20)](https://github.com/kdeldycke/extra-platforms/compare/v0.0.1...v1.0.0)
+
+                - Add documentation."""
+            ),
+        ),
+    ],
+)
+def test_changelog_update(version, initial, updated):
+    changelog = Changelog(initial)
+    # Force current version to match the one in the test data.
+    changelog.current_version = version
+    assert changelog.update() == updated