common-python-tasks 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

common_python_tasks/data/generic/cliff.toml

@@ -0,0 +1,5 @@
+[git]
+conventional_commits = true
+
+[bump]
+breaking_always_bump_major = false

common_python_tasks/git.py

@@ -1,7 +1,7 @@
 import logging
 import re
 import shutil
-from enum import IntEnum, StrEnum, auto
+from enum import StrEnum, auto
 from pathlib import Path
 from typing import Any, NamedTuple
 
@@ -27,14 +27,6 @@ class ReleaseComponent(StrEnum):
     PATCH = auto()
 
 
-class ReleaseComponentBump(IntEnum):
-    """Numeric bump positions expected by `Version.bump`."""
-
-    MAJOR = 0
-    MINOR = 1
-    PATCH = 2
-
-
 class ReleaseStage(StrEnum):
     """Supported pre-release stages."""
 
@@ -105,18 +97,12 @@ def compute_next_release_version(
         A `NextReleaseVersion` with the serialized new version and normalized component.
     """
     current_version_text = project.get_project_version_from_poetry()
-    release_component = component
-    if release_component is None:
-        release_component = infer_bump_component_from_git_cliff()
-        if re.match(r"^0\.", str(Version.parse(current_version_text).base)):
-            LOGGER.info(
-                "Current version %s is pre-production; using patch bump.",
-                current_version_text,
-            )
-            release_component = ReleaseComponent.PATCH
+    release_component = (
+        infer_bump_component_from_git_cliff() if component is None else component
+    )
 
     bumped = Version.parse(Version.parse(current_version_text).base).bump(
-        ReleaseComponentBump[release_component.name]
+        list(ReleaseComponent).index(release_component)
     )
     if stage is not None:
         bumped.stage = stage.value
@@ -179,10 +165,8 @@ def infer_bump_component_from_git_cliff() -> ReleaseComponent:
             "Install git-cliff or pass one of: major, minor, patch."
         )
 
-    result = utils.run_command(
-        ["git-cliff", "--bumped-version", "--unreleased"],
-        capture_output=True,
-        acceptable_returncodes={0},
+    result = utils.run_git_cliff(
+        ["--bumped-version", "--unreleased"], capture_output=True
     )
     version_text = result.stdout.strip()
     if not version_text:

common_python_tasks/tasks.py

@@ -166,10 +166,20 @@ def _resolve_allow_dirty_release(dirty_files: list[Path]) -> bool:
 
 
 def _update_release_changelog(release_tag: str, dry_run: bool = False) -> None:
-    from .utils import log_dry_run, prepend_changelog, run_command
+    from .utils import (
+        get_prepended_changelog_contents,
+        log_dry_run,
+        prepend_changelog,
+        run_command,
+    )
 
     changelog_path = Path("CHANGELOG.md")
     if dry_run:
+        LOGGER.debug(
+            "Dry-run rendered %s contents:\n%s",
+            changelog_path,
+            get_prepended_changelog_contents(release_tag, changelog_path),
+        )
         log_dry_run(
             "Would prepend generated git-cliff release notes for %s to %s",
             release_tag,
@@ -985,7 +995,7 @@ def changelog() -> None:
 
 
 def _run_release_flow(
-    component: str = "patch",
+    component: str = "auto",
     *,
     stage: str | None = None,
     dry_run: bool = False,
@@ -1105,7 +1115,7 @@ def _run_release_flow(
 
 @tasks.script(task_name="release", tags=["packaging", "release", "containers"])
 def release(
-    component: str = "patch",
+    component: str = "auto",
     *,
     stage: str | None = None,
     dry_run: bool = False,
@@ -1159,7 +1169,7 @@ def release(
 
 @tasks.script(task_name="release", tags=["packaging", "release", "common"])
 def release_without_containers(
-    component: str = "patch",
+    component: str = "auto",
     *,
     stage: str | None = None,
     dry_run: bool = False,

common_python_tasks/utils.py

@@ -10,7 +10,7 @@ from getpass import getuser
 from importlib.resources import files
 from pathlib import Path
 from shlex import quote
-from typing import Callable, Sequence
+from typing import Callable, Collection, Sequence
 
 from jinja2 import Template
 
@@ -120,7 +120,7 @@ def remove_path(path: Path) -> None:
 def run_command(
     command: Sequence[str | Path | None],
     capture_output: bool = False,
-    acceptable_returncodes: Sequence[int] | None = None,
+    acceptable_returncodes: Collection[int] | None = None,
     env: dict[str, str] | None = None,
     always_show_command: bool = False,
     dry_run: bool = False,
@@ -143,10 +143,9 @@ def run_command(
         The `CompletedProcess` instance from the subprocess run, or `None` for dry-run
         invocations.
     """
-    import subprocess
-
     if acceptable_returncodes is None:
         acceptable_returncodes = {0}
+    acceptable_returncodes = set(acceptable_returncodes)
 
     command = [str(c) for c in command if c is not None]
 
@@ -208,7 +207,18 @@ def load_data_file(
     try:
         data_files = files("common_python_tasks") / "data" / type_identifier
         data_file = data_files / file_name
-        return (Path(str(data_file)), data_file.read_text())
+        text = data_file.read_text()
+        # Try to provide a real filesystem Path when possible (packages in wheels
+        # may store resources inside archives). `as_file()` yields a real path
+        # via a context manager when supported by the Traversable.
+        try:
+            with data_file.as_file() as real_path:
+                return (Path(real_path), text)
+        except (AttributeError, OSError):
+            # Fall back to a Path constructed from the Traversable string
+            # representation so existing callers that index [0] still receive
+            # a Path-like object.
+            return (Path(str(data_file)), text)
     except FileNotFoundError as e:
         if fatal_on_missing:
             fatal(f"Data file not found: {file_name} ({e})")
@@ -239,7 +249,7 @@ def get_container_registry_url() -> str:
 
 
 @lru_cache
-def get_package_name(use_underscores: bool = False) -> str:
+def get_package_name(use_underscores: bool = False) -> str | None:
     """Return the package name from environment or pyproject configuration.
 
     Args:
@@ -250,9 +260,17 @@ def get_package_name(use_underscores: bool = False) -> str:
     """
     import tomllib
 
-    name = os.getenv("PACKAGE_NAME") or tomllib.loads(
-        Path("pyproject.toml").read_text()
-    ).get("project", {}).get("name")
+    name = os.getenv("PACKAGE_NAME")
+    if not name:
+        try:
+            pyproject = Path("pyproject.toml")
+            if pyproject.exists():
+                name = (
+                    tomllib.loads(pyproject.read_text()).get("project", {}).get("name")
+                )
+        except Exception as e:  # pragma: no cover - defensive logging
+            LOGGER.debug("Unable to read pyproject.toml: %s", e)
+
     if use_underscores and name:
         name = package_name_to_underscore(name)
     return name
@@ -340,13 +358,47 @@ def run_git_cliff(
     Returns:
         The `CompletedProcess` result, or `None` for dry-run invocations.
     """
+    config_path = get_config_path(
+        "GIT_CLIFF_CONFIG",
+        "cliff.toml",
+        "cliff.toml",
+    )
     return run_command(
-        ["git-cliff", *args],
+        ["git-cliff", "--config", config_path if config_path else None, *args],
         capture_output=capture_output,
         acceptable_returncodes={0},
     )
 
 
+def get_prepended_changelog_contents(
+    tag_name: str,
+    changelog_path: Path = Path("CHANGELOG.md"),
+) -> str:
+    """Return changelog content with release notes prepended for the given tag.
+
+    Args:
+        tag_name: The release tag to generate changelog entries for.
+        changelog_path: The changelog file to read as the base content.
+
+    Returns:
+        The full changelog text as it would look after prepending release notes.
+    """
+    existing_changelog = (
+        changelog_path.read_text(encoding="utf-8")
+        if changelog_path.exists()
+        else "# Changelog\n\n## [Unreleased]\n"
+    )
+    res = run_git_cliff(["--unreleased", "--tag", tag_name], capture_output=True)
+    release_notes = res.stdout if (res and res.stdout) else ""
+    if release_notes.strip():
+        # Ensure the prepended section is separated from existing content.
+        release_notes = release_notes.rstrip("\n") + "\n\n"
+    else:
+        release_notes = ""
+
+    return release_notes + existing_changelog
+
+
 def prepend_changelog(
     tag_name: str,
     changelog_path: Path = Path("CHANGELOG.md"),
@@ -360,25 +412,20 @@ def prepend_changelog(
         tag_name: The release tag to generate changelog entries for.
         changelog_path: The path to the changelog file to prepend to.
     """
-    if not changelog_path.exists():
-        changelog_path.write_text("# Changelog\n\n## [Unreleased]\n", encoding="utf-8")
-    release_notes = run_git_cliff(
-        ["--unreleased", "--tag", tag_name], capture_output=True
-    ).stdout
-    if release_notes and not release_notes.endswith("\n"):
-        release_notes += "\n"
-
-    existing_changelog = changelog_path.read_text(encoding="utf-8")
-    changelog_path.write_text(release_notes + existing_changelog, encoding="utf-8")
+    changelog_path.write_text(
+        get_prepended_changelog_contents(tag_name, changelog_path),
+        encoding="utf-8",
+    )
 
 
 def changelog() -> str | None:
     """Generate release notes from git-cliff for unreleased commits."""
-    result = run_git_cliff(["--unreleased"], capture_output=True).stdout
-    if not result:
+    res = run_git_cliff(["--unreleased"], capture_output=True)
+    if not res or not res.stdout:
         LOGGER.warning("git-cliff produced no release notes for unreleased commits")
-        return result
+        return None
 
+    result = res.stdout
     return re.sub(
         r"(?im)\A##\s*\[?unreleased\]?\s*\n?",
         "",

{common_python_tasks-0.3.0.dist-info → common_python_tasks-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: common-python-tasks
-Version: 0.3.0
+Version: 0.3.1
 Summary: Opinionated Poe the Poet tasks for Python package development.
 License-Expression: MIT
 License-File: LICENSE
@@ -50,7 +50,7 @@ curl -sSL https://api.github.com/repos/ci-sourcerer/common-python-tasks/contents
 To install a specific release, set the environment variable `COMMON_PYTHON_TASKS_VERSION`.
 
 ```shell
-COMMON_PYTHON_TASKS_VERSION=0.3.0 \
+COMMON_PYTHON_TASKS_VERSION=0.3.1 \
   sh -c "$(curl -sSL https://api.github.com/repos/ci-sourcerer/common-python-tasks/contents/scripts/add-common-python-tasks.sh | jq -r '.content' | base64 -d)"
 ```
 
@@ -71,9 +71,9 @@ There's no real reason to run the automated script; I just like automating every
     ```toml
     [project]
     name = "my-awesome-project"
-    version = "0.3.0"
+    version = "0.3.1"
     dependencies = [
-        "common-python-tasks==0.3.0",  # Always pin to a specific version
+        "common-python-tasks==0.3.1",  # Always pin to a specific version
     ]
 
     [tool.poe]
@@ -287,8 +287,8 @@ By default, `tasks()` exposes the common task set. You can still include or excl
 ```toml
 [project]
 name = "simple-cli-tool"
-version = "0.3.0"
-dependencies = ["common-python-tasks==0.3.0"]
+version = "0.3.1"
+dependencies = ["common-python-tasks==0.3.1"]
 
 [tool.poe]
 include_script = "common_python_tasks:tasks()"
@@ -301,8 +301,8 @@ Available tasks: common defaults such as `format`, `lint`, `test`, and `build`.
 ```toml
 [project]
 name = "containerized-app"
-version = "0.3.0"
-dependencies = ["common-python-tasks==0.3.0"]
+version = "0.3.1"
+dependencies = ["common-python-tasks==0.3.1"]
 
 [tool.poe]
 include_script = "common_python_tasks:tasks(include_tags=['common', 'containers'])"
@@ -319,7 +319,7 @@ Available tasks: All tasks including `build-image` and `push-image`.
 ```toml
 [project]
 name = "custom-test-setup"
-dependencies = ["common-python-tasks==0.3.0"]
+dependencies = ["common-python-tasks==0.3.1"]
 dynamic = ["version"]
 
 [tool.poe]

{common_python_tasks-0.3.0.dist-info → common_python_tasks-0.3.1.dist-info}/RECORD

@@ -12,16 +12,17 @@ common_python_tasks/data/generic/.flake8,sha256=PzH98ak-AKcENaBCzOhI2eHvLxrneklm
 common_python_tasks/data/generic/.isort.cfg,sha256=P_hdco_n95VeXJjlUcXkChqNdct0SNDuk_n9ZaHzXPE,71
 common_python_tasks/data/generic/Dockerfile.deps.j2,sha256=rCGsBwLHQIRsGFzDbiRi_nWc-SZ3MAFZ_BeZJFV28Ck,432
 common_python_tasks/data/generic/Dockerfile.j2,sha256=QBWryTMqEPLpPehUyQHAiLCbKFlrC9VjkE4Sv56t1bk,5467
+common_python_tasks/data/generic/cliff.toml,sha256=po1MnEGEEgrpyBz3XLWr0h7emXb6ASX63lrU2r6o240,77
 common_python_tasks/data/generic/pytest.ini,sha256=RHak5QrLzKHvUBjFmaaiOYFrd_8YBRQubXEOT0NJfco,134
 common_python_tasks/docker.py,sha256=lS22ecY1rVCkYGPc7hDgXNM-e-TjIW3ce9Um9FOiW7A,17515
 common_python_tasks/docker_compose.py,sha256=DN4cap0lGxBSCYwEXXSytbq4V5NPVv35e8KyCPTsMhM,20828
 common_python_tasks/env.py,sha256=G4CF2c3vpUe6qs_WNW41b4IqUnAMBwAuTnUyd8PwExk,13671
-common_python_tasks/git.py,sha256=smnZNAjmkmtoZAMCpC8y1IG1WiCA9_JANmIbqmcukgA,11151
+common_python_tasks/git.py,sha256=PCkx6cvWRqarEhDV3aJCPUrjcVxxaZq03ZWY8JqD9Yo,10642
 common_python_tasks/github.py,sha256=32u4LshDOJpyah8I00c1IKeopNJCWAM8M8Ci2SOdxhQ,18983
 common_python_tasks/project.py,sha256=SIZRaj0wvPXQbfJOa9jCJJ6F6M_p2QeYjZUMVRsCPjI,10062
-common_python_tasks/tasks.py,sha256=UsIQrvhb_DVUKCPe05JN8x1Ti7jFDAziiffg9Eg_SZY,49884
-common_python_tasks/utils.py,sha256=6beDRT9Y_gtIRyYO_P6RpOCmGfeu0K34VCu-EZSLey8,12217
-common_python_tasks-0.3.0.dist-info/METADATA,sha256=sm81vRaK2M21Id2HB4bTJdRC8ayDqRGxHRXnWhR_tWo,21396
-common_python_tasks-0.3.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
-common_python_tasks-0.3.0.dist-info/licenses/LICENSE,sha256=RsSweM-DyzxFPx38fQOJqHrKyeT9Fiz8rO7yox-fOsw,1070
-common_python_tasks-0.3.0.dist-info/RECORD,,
+common_python_tasks/tasks.py,sha256=nIIf4HaQoAUSy89ybg1zMNZwxKL1xIYwiCXHnY52uJo,50140
+common_python_tasks/utils.py,sha256=RTVMeNyoIVvnJYsg92yXOVelEXlsLumO9Bgdqyx6BHw,14001
+common_python_tasks-0.3.1.dist-info/METADATA,sha256=VvvfJdJJYUowwh8jm1t704ThsjIdk_Hm_6Z-9xCEUQc,21396
+common_python_tasks-0.3.1.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
+common_python_tasks-0.3.1.dist-info/licenses/LICENSE,sha256=RsSweM-DyzxFPx38fQOJqHrKyeT9Fiz8rO7yox-fOsw,1070
+common_python_tasks-0.3.1.dist-info/RECORD,,

{common_python_tasks-0.3.0.dist-info → common_python_tasks-0.3.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.4.0
+Generator: poetry-core 2.4.1
 Root-Is-Purelib: true
 Tag: py3-none-any