proj-flow 0.15.2__tar.gz → 0.16.0__tar.gz

{proj_flow-0.15.2 → proj_flow-0.16.0}/CHANGELOG.rst

@@ -4,6 +4,22 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+`0.16.0 <https://github.com/mzdun/proj-flow/compare/v0.15.3...v0.16.0>`_ (2025-03-02)
+=====================================================================================
+
+New Features
+------------
+
+- add bootstrap action (`57cf99b <https://github.com/mzdun/proj-flow/commit/57cf99bad7c34aa22d357746824647499d70eb07>`_)
+
+`0.15.3 <https://github.com/mzdun/proj-flow/compare/v0.15.2...v0.15.3>`_ (2025-02-24)
+=====================================================================================
+
+Bug Fixes
+---------
+
+- only use two most-recent minor versions in YAML (`24e4b05 <https://github.com/mzdun/proj-flow/commit/24e4b05c6bb6c3dc2a7db534e49f7ba542d396da>`_)
+
 `0.15.2 <https://github.com/mzdun/proj-flow/compare/v0.15.1...v0.15.2>`_ (2025-02-24)
 =====================================================================================
 

{proj_flow-0.15.2 → proj_flow-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.15.2
+Version: 0.16.0
 Summary: C++ project maintenance, automated
 Project-URL: Changelog, https://github.com/mzdun/proj-flow/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://proj-flow.readthedocs.io/en/latest/

proj_flow-0.16.0/actions/bootstrap/action.yml

@@ -0,0 +1,49 @@
+name: Python + Project Flow bootstrap
+author: Marcin Zdun
+
+inputs:
+  python-version:
+    description: "Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset."
+
+outputs:
+  version:
+    description: Version of the `proj-flow` this project expects
+    value: ${{ steps.version.outputs.version }}
+
+  is-flow-app:
+    description: Checks, if this project is a Flow project
+    value: ${{ steps.version.outputs.is-flow-app }}
+
+runs:
+  using: composite
+  steps:
+    - name: python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: check version
+      id: version
+      shell: python
+      run: |
+        import os
+        import sys
+
+        ACTION_PATH = r'${{ github.action_path }}'.replace('/', os.sep)
+        sys.path.insert(0, ACTION_PATH)
+
+        import version
+      env:
+        RUNNER_CONTEXT: ${{ toJson(runner) }}
+
+    - name: .flow/.venv cache
+      if: ${{ fromJson(steps.version.outputs.is-flow-app) }}
+      uses: actions/cache@v4
+      with:
+        path: .flow/.venv
+        key: ${{ steps.version.outputs.venv-cache-key }}
+
+    - name: bootstrap
+      if: ${{ fromJson(steps.version.outputs.is-flow-app) }}
+      run: python ./.flow/flow.py bootstrap
+      shell: bash

proj_flow-0.16.0/actions/bootstrap/version.py

@@ -0,0 +1,46 @@
+import os
+import json
+from platform import machine
+from typing import cast
+
+VAR_NAME = "CXX_FLOW_VERSION"
+VARIABLE = ""
+IS_FLOW_APP = False
+
+RUNNER = cast(dict, json.loads(os.environ["RUNNER_CONTEXT"]))
+RUNNER_OS = RUNNER.get("os", os.name)
+RUNNER_ARCH = RUNNER.get("arch", machine() or "unk-arch")
+
+try:
+    with open(".flow/flow.py", encoding="UTF-8") as flow_py:
+        for line in flow_py:
+            if not line.startswith(VAR_NAME):
+                continue
+
+            var_list = line.split("=", 1)
+            if len(var_list) != 2:
+                continue
+
+            var = var_list[0].strip()
+            if var != VAR_NAME:
+                continue
+
+            val = var_list[1].strip()
+            start = val[:1]
+            if start not in "\"'":
+                continue
+
+            VARIABLE = val[1:].split(start, 1)[0].strip()
+            break
+
+    IS_FLOW_APP = True
+
+except FileNotFoundError:
+    pass
+
+VENV_CACHE_KEY = f"venv-{RUNNER_OS}-{RUNNER_ARCH}-{VARIABLE}"
+
+with open(os.environ["GITHUB_OUTPUT"], "a", encoding="UTF-8") as out:
+    print(f"version={VARIABLE}", file=out)
+    print(f"venv-cache-key={VENV_CACHE_KEY}", file=out)
+    print(f"is-flow-app={json.dumps(IS_FLOW_APP)}", file=out)

{proj_flow-0.15.2 → proj_flow-0.16.0}/src/proj_flow/__init__.py

@@ -6,4 +6,4 @@ The **proj_flow** contains only ``__version__`` to be updated, nothing more.
 This is in an attempt to make this module easy to load initially.
 """
 
-__version__ = "0.15.2"
+__version__ = "0.16.0"

{proj_flow-0.15.2 → proj_flow-0.16.0}/src/proj_flow/log/commit.py

@@ -139,7 +139,11 @@ def _get_commit(hash: str, short_hash: str, message: str) -> Optional[Commit]:
 
     breaking_change = None
     body = "\n".join(lines).strip().split("BREAKING CHANGE", 1)
-    if len(body) > 1:
+    if (
+        len(body) > 1
+        and (len(body[0]) == 0 or body[0][-1:] == "\n")
+        and (len(body[1]) == 1 or body[1][:1] == ":")
+    ):
         body = body[1].lstrip(":").strip()
         breaking_change = [
             re.sub(r"\s+", " ", para.strip()) for para in body.split("\n\n")

{proj_flow-0.15.2 → proj_flow-0.16.0}/src/proj_flow/log/release.py

@@ -6,8 +6,7 @@ The **proj_flow.log.release** performs a relase on the hosting service.
 """
 
 import typing
-from abc import ABC, abstractmethod
-from typing import Iterable, Union
+from typing import Iterable, Optional, Union
 
 from proj_flow import api
 from proj_flow.api import env
@@ -18,9 +17,14 @@ from proj_flow.log.error import NoProjectError, VersionNotAdvancing
 OneOrMoreStrings = Union[str, Iterable[str]]
 
 
-class VersionUpdater(ABC):
-    @abstractmethod
-    def on_version_change(self, new_version: str) -> OneOrMoreStrings: ...
+class VersionUpdater:
+    def on_version_change(self, new_version: str) -> Optional[OneOrMoreStrings]:
+        return None
+
+    def on_version_change_tags(
+        self, new_version: str, tags: list[str]
+    ) -> Optional[OneOrMoreStrings]:
+        return self.on_version_change(new_version)
 
 
 version_updaters = registry.Registry[VersionUpdater]("VersionUpdater")
@@ -114,8 +118,10 @@ def add_release(
             files_to_commit.append(version_path)
 
         for updater in version_updaters.get():
-            modified = updater.on_version_change(next_version)
-            if isinstance(modified, str):
+            modified = updater.on_version_change_tags(next_version, tags)
+            if modified is None:
+                continue
+            elif isinstance(modified, str):
                 files_to_commit.append(modified)
             else:
                 files_to_commit.extend(modified)

{proj_flow-0.15.2 → proj_flow-0.16.0}/src/proj_flow/minimal/base.py

@@ -12,6 +12,7 @@ from typing import List
 from proj_flow import __version__, api
 from proj_flow.flow import layer
 
+
 class GitInit(api.init.InitStep):
     layers: List[layer.LayerInfo] = []
 
@@ -27,7 +28,7 @@ class GitInit(api.init.InitStep):
 
         git("init")
         git("add", ".")
-        
+
         executables: List[str] = []
 
         for fs_layer in GitInit.layers:

proj_flow-0.16.0/src/proj_flow/minimal/ext/bug_report.py

@@ -0,0 +1,75 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.minimal.ext.bug_report** adds next version to bug_report.yaml
+next to CHANGELOG.rst.
+"""
+
+import re
+import sys
+from typing import List, Tuple
+
+from proj_flow.log import release
+
+YAML_PATH = ".github/ISSUE_TEMPLATE/bug_report.yaml"
+
+
+def _version(ver: str) -> Tuple[int, int, int, str]:
+    if ver[:1] == "v":
+        ver = ver[1:]
+
+    m = re.match(r"([0-9]+)\.([0-9]+)\.([0-9]+)(.*)", ver)
+    if m is None:
+        print(f"fatal error: cannot parse {ver}", file=sys.stderr)
+        raise SystemExit(1)
+    return (int(m.group(1)), int(m.group(2)), int(m.group(3)), ver)
+
+def _prev_version(new_version: str, tags: List[str]):
+    current = _version(new_version)
+    versions = [_version(tag) for tag in reversed(tags)]
+    index = 0
+    while index < len(versions):
+        comp = versions[index]
+        if comp[0] != current[0] or comp[1] != current[1]:
+            break
+
+        index += 1
+    if index >= len(versions):
+        index = 0
+
+    return None if index > len(versions) else versions[index][-1]
+
+@release.version_updaters.add
+class VersionUpdater(release.VersionUpdater):
+    def on_version_change_tags(self, new_version: str, tags: List[str]):
+        old_version = _prev_version(new_version, tags)
+
+        range = [f"      - Current (v{new_version})\n"]
+        if old_version:
+            range.extend(
+                [
+                    f"      - Previous (v{old_version})\n",
+                    f"      - Older, than v{old_version}\n",
+                ]
+            )
+
+        with open(YAML_PATH, encoding="UTF-8") as inf:
+            lines = inf.readlines()
+
+        try:
+            id_index = lines.index("  id: version\n")
+            option_index = lines.index("    options:\n", id_index) + 1
+            option_index_end = option_index
+            while option_index_end < len(lines) and lines[option_index_end].startswith(
+                "      - "
+            ):
+                option_index_end += 1
+            lines[option_index:option_index_end] = range
+        except ValueError as e:
+            print(e, file=sys.stderr)
+
+        with open(YAML_PATH, "w", encoding="UTF-8") as outf:
+            outf.writelines(lines)
+
+        return YAML_PATH

proj_flow-0.15.2/src/proj_flow/minimal/ext/bug_report.py

@@ -1,33 +0,0 @@
-# Copyright (c) 2025 Marcin Zdun
-# This code is licensed under MIT license (see LICENSE for details)
-
-"""
-The **proj_flow.minimal.ext.bug_report** adds next version to bug_report.yaml
-next to CHANGELOG.rst.
-"""
-
-import re
-import sys
-
-from proj_flow.log import release
-
-YAML_PATH = ".github/ISSUE_TEMPLATE/bug_report.yaml"
-
-
-@release.version_updaters.add
-class VersionUpdater(release.VersionUpdater):
-    def on_version_change(self, new_version: str):
-        with open(YAML_PATH, encoding="UTF-8") as inf:
-            lines = inf.readlines()
-
-        try:
-            id_index = lines.index("  id: version\n")
-            option_index = lines.index("    options:\n", id_index) + 1
-            lines[option_index:option_index] = f"      - v{new_version}\n"
-        except ValueError as e:
-            print(e, file=sys.stderr)
-
-        with open(YAML_PATH, "w", encoding="UTF-8") as outf:
-            outf.writelines(lines)
-
-        return YAML_PATH