proj-flow 0.11.3__tar.gz → 0.13.0__tar.gz

{proj_flow-0.11.3 → proj_flow-0.13.0}/CHANGELOG.rst

@@ -4,6 +4,22 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+`0.13.0 <https://github.com/mzdun/proj-flow/compare/v0.12.0...v0.13.0>`_ (2025-02-22)
+=====================================================================================
+
+New Features
+------------
+
+- calculate lts.ubuntu from current date (`2bfa12e <https://github.com/mzdun/proj-flow/commit/2bfa12e87cf7b5b163ef88473d2f4779afeed938>`_)
+
+`0.12.0 <https://github.com/mzdun/proj-flow/compare/v0.11.3...v0.12.0>`_ (2025-02-22)
+=====================================================================================
+
+New Features
+------------
+
+- add ``github publish`` (`2f6ef1e <https://github.com/mzdun/proj-flow/commit/2f6ef1eaf4053f25633bf3f5037991fa4567023b>`_)
+
 `0.11.3 <https://github.com/mzdun/proj-flow/compare/v0.11.2...v0.11.3>`_ (2025-02-19)
 =====================================================================================
 

{proj_flow-0.11.3 → proj_flow-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.11.3
+Version: 0.13.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.11.3 → proj_flow-0.13.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.11.3"
+__version__ = "0.13.0"

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/api/release.py

@@ -56,6 +56,14 @@ class Project:
     def tag_name(self):
         return f"v{self.version}"
 
+    @property
+    def package_prefix(self):
+        return f"{self.archive_name}-"
+
+    @property
+    def package_suffix(self):
+        return ""
+
 
 class ProjectSuite(ABC):
     @abstractmethod
@@ -97,3 +105,13 @@ class ProjectSuite(ABC):
 
 
 project_suites = registry.Registry[ProjectSuite]("ProjectSuite")
+
+
+def get_project(rt: env.Runtime):
+    def wrap(suite: ProjectSuite):
+        return suite.get_project(rt)
+
+    _, project = project_suites.find(wrap)
+    if project is None:
+        rt.fatal(f"Cannot get project information from {rt.root}")
+    return project

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/base/cmd.py

@@ -5,8 +5,10 @@
 The **proj_flow.base.cmd** defines environment for `proj_flow.api.env.Runtime`.
 """
 
+import os
 import shutil
 import subprocess
+from contextlib import contextmanager
 from typing import Optional
 
 
@@ -48,3 +50,13 @@ def run(app: str, *args: str, capture_output=False):
     return subprocess.run(
         [cmd, *args], shell=False, encoding="UTF-8", capture_output=capture_output
     )
+
+
+@contextmanager
+def cd(path: str):
+    prev = os.getcwd()
+    os.chdir(path)
+    try:
+        yield
+    finally:
+        os.chdir(prev)

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/ext/cplusplus/cmake/__init__.py

@@ -7,6 +7,6 @@ The **proj_flow.ext.cplusplus.cmake** provides ``"CMake"``, ``"Build"``,
 context.
 """
 
-from . import parser, steps, version
+from . import parser, project, steps
 
-__all__ = ["parser", "steps", "version"]
+__all__ = ["parser", "project", "steps"]

proj_flow-0.11.3/src/proj_flow/ext/cplusplus/cmake/version.py → proj_flow-0.13.0/src/proj_flow/ext/cplusplus/cmake/project.py

@@ -5,12 +5,8 @@
 The **proj_flow.ext.cplusplus.cmake.version** provides project suite plugin.
 """
 
-import os
-import re
 from typing import NamedTuple, Optional
 
-import toml
-
 from proj_flow.api import env, release
 from proj_flow.ext.cplusplus.cmake.parser import get_project
 

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/ext/github/cli.py

@@ -15,8 +15,9 @@ import sys
 import typing
 
 from proj_flow import log
-from proj_flow.api import arg, env
+from proj_flow.api import arg, env, release
 from proj_flow.base.name_list import name_list
+from proj_flow.ext.github import publishing
 from proj_flow.flow.configs import Configs
 from proj_flow.log import commit, hosting, rich_text
 
@@ -63,7 +64,7 @@ def matrix(
 
 
 @arg.command("github", "release")
-def release(
+def release_cmd(
     rt: env.Runtime,
     all: typing.Annotated[
         bool, arg.FlagArgument(help="Take all Conventional Commits.")
@@ -72,7 +73,7 @@ def release(
         typing.Optional[str],
         arg.Argument(
             help="Ignore the version change from changelog and instead use this value. "
-            f"Allowed values are: {name_list(FORCED_LEVEL_CHOICES)}",
+            f"Allowed values are: {name_list(FORCED_LEVEL_CHOICES)}.",
             meta="level",
             choices=FORCED_LEVEL_CHOICES,
         ),
@@ -86,9 +87,9 @@ def release(
     ],
 ):
     """
-    Bumps the project version based on current git logs, creates a "chore"
-    commit for the change, attaches an annotated tag with the version number
-    and pushes it all to GitHub.
+    Bump the project version based on current git logs, create a "chore"
+    commit for the change, attach an annotated tag with the version number
+    and push it all to GitHub.
     """
 
     generator = (
@@ -123,3 +124,62 @@ def release(
                 with open(GITHUB_OUTPUT, "a", encoding="UTF-8") as github_output:
                     print(f"tag={next_tag}", file=github_output)
                     print(f"released={json.dumps(released)}", file=github_output)
+
+
+@arg.command("github", "publish")
+def publish(
+    rt: env.Runtime,
+    ref: typing.Annotated[
+        typing.Optional[str],
+        arg.Argument(
+            help="Publish this release draft. In case this is called from within "
+            "GitHub Actions and your release is named exactly like the tag used to "
+            "trigger this flow, you can use ${{github.action_ref}} variable. "
+            "Defaults to current tag.",
+            meta="release",
+        ),
+    ],
+    upload: typing.Annotated[
+        typing.Optional[str],
+        arg.Argument(
+            help="If present, upload files from the directory to the referenced "
+            "release before publishing.",
+            meta="directory",
+        ),
+    ],
+):
+    """
+    Upload package artifacts to a GitHub release and in case the release
+    is still in draft, publish it.
+    """
+
+    git = commit.Git(rt)
+    gh_links = hosting.github.GitHub.from_repo(git) or commit.NoHosting()
+    project = release.get_project(rt)
+
+    tag_name = ref or project.tag_name
+
+    release_info = gh_links.locate_release(tag_name)
+    if release_info is None and not rt.dry_run:
+        rt.fatal(f"No release matches {tag_name}")
+
+    if upload is not None:
+        matcher = publishing.build_regex(project)
+        directory, names = publishing.gather_artifacts(upload, matcher)
+        if not len(names):
+            rt.fatal(f"No artifact matches {matcher.pattern}")
+
+        publishing.checksums(rt, directory, names, "sha256sum.txt")
+
+        if release_info is not None:
+            gh_links.upload_to_release(release_info, directory, names)
+        else:
+            rt.message(f"Would upload:", level=env.Msg.STATUS)
+            for name in names:
+                rt.message(f"  * {name}", level=env.Msg.STATUS)
+
+    if release_info is not None:
+        info = gh_links.publish(release_info)
+        if info.url:
+            msg = "Visit draft at" if info.is_draft else "Visit release at"
+            rt.message(msg, info.url, level=env.Msg.ALWAYS)

proj_flow-0.13.0/src/proj_flow/ext/github/publishing.py

@@ -0,0 +1,65 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.github.publishing** provides utilities for ``github
+publish`` command.
+"""
+
+
+import hashlib
+import io
+import os
+import re
+import typing
+import zipfile
+
+from proj_flow.api import env, release
+
+
+def _safe_regex(value: str) -> str:
+    for esc in "\\.+*?()[]":
+        value = value.replace(esc, f"\\{esc}")
+    return value
+
+
+def build_regex(project: release.Project):
+    regexPre = _safe_regex(project.package_prefix)
+    regexPost = _safe_regex(project.package_suffix)
+    regex = f"^{regexPre}(.*){regexPost}$"
+    return re.compile(regex)
+
+
+def gather_artifacts(directory: str, matcher: re.Pattern):
+    if os.path.isdir(directory):
+        for _, dirnames, filenames in os.walk(directory):
+            dirnames[:] = []
+            names = [name for name in filenames if matcher.match(name)]
+    else:
+        next_directory = f"{directory}-dir"
+        os.makedirs(next_directory, exist_ok=True)
+        with zipfile.ZipFile(directory) as zip:
+            names = [name for name in zip.namelist() if matcher.match(name)]
+            for name in names:
+                zip.extract(name, path=next_directory)
+        directory = next_directory
+
+    return directory, names
+
+
+def _hash(filename: str) -> str:
+    sha = hashlib.sha256()
+    with open(filename, "rb") as data:
+        for block in iter(lambda: data.read(io.DEFAULT_BUFFER_SIZE), b""):
+            sha.update(block)
+    return sha.hexdigest()
+
+
+def checksums(rt: env.Runtime, directory: str, names: typing.List[str], outname: str):
+    rt.print("sha256sum", "-b")
+    if not rt.dry_run:
+        with open(os.path.join(directory, outname), "w") as output:
+            for name in names:
+                digest = _hash(os.path.join(directory, name))
+                print(f"{digest} *{name}", file=output)
+    names.append(outname)

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/ext/python/rtdocs.py

@@ -15,6 +15,7 @@ from contextlib import contextmanager
 from typing import Any, Callable, Dict, List, Optional, cast
 
 from proj_flow.api import env, step
+from proj_flow.base import cmd
 
 
 @step.register
@@ -172,16 +173,6 @@ _job_listing = [
 ]
 
 
-@contextmanager
-def _cd(path: str):
-    prev = os.getcwd()
-    os.chdir(path)
-    try:
-        yield
-    finally:
-        os.chdir(prev)
-
-
 def _get_venv_path(root: str):
     bindir = os.path.join(".venv", "bin")
     scripts = os.path.join(".venv", "Scripts")
@@ -198,7 +189,7 @@ def _get_venv_path(root: str):
 def _activate_virtual_env(venv, root: str):
     global PYTHON_EXECUTABLE
 
-    with _cd(root):
+    with cmd.cd(root):
         exec_ext = ".exe" if sys.platform == "win32" else ""
         python_exec = f"python{exec_ext}"
         bindir = _get_venv_path(root)

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/ext/store.py

@@ -25,13 +25,6 @@ def _package_name(config: env.Config, pkg: str, group: str):
     return f"{pkg}-{_system}{_version}-{_arch}{debug}{suffix}"
 
 
-def _get_project(rt: env.Runtime):
-    def wrap(suite: release.ProjectSuite):
-        return suite.get_project(rt)
-
-    return wrap
-
-
 @step.register
 class StorePackages(step.Step):
     """Stores archives and installers build for ``preset`` config value."""
@@ -52,10 +45,7 @@ class StorePackages(step.Step):
 
         global _project_pkg
         if _project_pkg is None:
-            _, project = release.project_suites.find(_get_project(rt))
-            if project is None:
-                rt.fatal(f"Cannot get project information from {rt.root}")
-            _project_pkg = project.archive_name
+            _project_pkg = release.get_project(rt).archive_name
 
         main_group = cast(str, rt._cfg.get("package", {}).get("main-group"))
         if main_group is not None and not rt.dry_run:

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/flow/configs.py

@@ -9,7 +9,9 @@ using ``-D`` switches.
 
 
 import argparse
+import datetime
 import os
+import sys
 from typing import Any, Callable, Dict, List
 
 from proj_flow.api import env
@@ -90,9 +92,43 @@ def _expand_one(config: dict, github_os: str, os_in_name: str):
     return config
 
 
+__printed_lts_ubuntu_warning = False
+
+
+def _ubuntu_lts(today=datetime.date.today(), lts_years=5):
+    year = today.year
+    for y in range(year - lts_years, year + 1):
+        if y % 2 != 0:
+            continue
+        release = datetime.date(y, 4, 1)
+        end_of_life = datetime.date(y + lts_years, 1, 31)
+        if release > today or end_of_life < today:
+            continue
+        yield f"ubuntu-{y % 100}.04"
+
+
+def _lts_list(config: dict, lts_list: Dict[str, List[str]]):
+    os = config["os"]
+    raw = lts_list.get(os)
+    if os == "ubuntu":
+        if raw is not None:
+            global __printed_lts_ubuntu_warning
+            if not __printed_lts_ubuntu_warning:
+                __printed_lts_ubuntu_warning = True
+                print(
+                    "\033[1;33m-- lts.ubuntu in config.yaml is deprecated; "
+                    "please remove it, so it can be calculated base on "
+                    "current date\033[m",
+                    file=sys.stderr,
+                )
+        else:
+            raw = list(_ubuntu_lts())
+    return raw or []
+
+
 def _expand_config(config: dict, spread_lts: bool, lts_list: Dict[str, List[str]]):
     if spread_lts:
-        spread = lts_list.get(config["os"], [])
+        spread = _lts_list(config, lts_list)
         if len(spread):
             return [
                 _expand_one({key: config[key] for key in config}, lts, lts)
@@ -136,6 +172,11 @@ class Configs:
         # from commands/github
         spread_lts = hasattr(args, "matrix") and not not args.matrix
 
+        if not spread_lts:
+            # allow "run" to see the warning about "lts.ubuntu"
+            for config in configs:
+                _lts_list(config, rt.lts_list)
+
         turned = matrix.flatten(
             [
                 _expand_config(config, spread_lts, rt.lts_list)

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/log/commit.py

@@ -188,7 +188,10 @@ def _sem_ver(tag: str):
 
 @dataclass
 class ReleaseInfo:
-    draft_url: Optional[str]
+    url: Optional[str] = None
+    is_draft: Optional[bool] = None
+    ref: Optional[str] = None
+    tag: Optional[str] = None
 
 
 class Hosting(ABC):
@@ -241,6 +244,32 @@ class Hosting(ABC):
         """
         ...
 
+    @abstractmethod
+    def locate_release(self, release_name: str) -> Optional[ReleaseInfo]:
+        """
+        Locate a release by its name.
+        """
+        ...
+
+    @abstractmethod
+    def upload_to_release(
+        self,
+        release: ReleaseInfo,
+        directory: str,
+        names: list[str],
+    ):
+        """
+        Upload package artifacts to the release.
+        """
+        ...
+
+    @abstractmethod
+    def publish(self, release: ReleaseInfo) -> ReleaseInfo:
+        """
+        Publish given release, return updated release info.
+        """
+        ...
+
 
 class NoHosting(Hosting):
     """
@@ -266,7 +295,21 @@ class NoHosting(Hosting):
     def add_release(
         self, log: ChangeLog, setup: "LogSetup", git: "Git", draft: bool
     ) -> ReleaseInfo:
-        return ReleaseInfo(draft_url=None)
+        return ReleaseInfo(is_draft=False)
+
+    def locate_release(self, release_name: str) -> Optional[ReleaseInfo]:
+        return None
+
+    def upload_to_release(
+        self,
+        release: ReleaseInfo,
+        directory: str,
+        names: list[str],
+    ):
+        return None
+
+    def publish(self, release: ReleaseInfo):
+        return ReleaseInfo(is_draft=False)
 
 
 @dataclass

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/log/hosting/github.py

@@ -23,6 +23,21 @@ class _GitHub(NamedTuple):
 _NO_GITHUB = _GitHub("", "", "")
 
 
+class ReleaseInfo(commit.ReleaseInfo):
+    id: int
+
+    def __init__(
+        self,
+        url: Optional[str],
+        is_draft: Optional[bool],
+        id: int,
+        ref: Optional[str] = None,
+        tag: Optional[str] = None,
+    ):
+        super().__init__(url, is_draft, ref, tag)
+        self.id = id
+
+
 class GitHub(commit.Hosting):
     """
     Generates links to GitHub.
@@ -78,6 +93,7 @@ class GitHub(commit.Hosting):
         *args: str,
         method: Optional[str] = None,
         capture_output: bool = True,
+        ro_call: bool = False,
         **kwargs,
     ):
         url = f"{self.root}{res}"
@@ -94,15 +110,18 @@ class GitHub(commit.Hosting):
             call.extend(["--method", method.upper()])
 
         if capture_output:
-            if self.rt.dry_run:
+            if not ro_call and self.rt.dry_run:
                 self.rt.print(*call, url, *args)
                 return None
             return self.rt.capture(*call, url, *args)
 
-        self.rt.print(*call, url, *args)
+        return self._run(*call, url, *args)
+
+    def _run(self, *args: str):
+        self.rt.print(*args)
         if self.rt.dry_run:
             return None
-        return cmd.run(*call, url, *args)
+        return cmd.run(*args)
 
     def json_from(
         self,
@@ -111,8 +130,9 @@ class GitHub(commit.Hosting):
         method: Optional[str] = None,
         server: Optional[str] = None,
         default: Any = {},
+        ro_call: bool = False,
     ):
-        proc = self.gh(res, *args, method=method, server=server)
+        proc = self.gh(res, *args, method=method, server=server, ro_call=ro_call)
         if proc is None:
             return default
 
@@ -131,6 +151,15 @@ class GitHub(commit.Hosting):
 
         return json.loads(proc.stdout)
 
+    def _release_from_json(self, data: dict, draft: bool = False):
+        html_url = cast(Optional[str], data.get("html_url"))
+        draft = cast(bool, data.get("draft", draft))
+        id = cast(int, data.get("id", 0))
+        name = cast(str, data.get("name"))
+        tag_name = cast(str, data.get("tag_name"))
+
+        return ReleaseInfo(url=html_url, is_draft=draft, id=id, ref=name, tag=tag_name)
+
     def add_release(
         self,
         log: commit.ChangeLog,
@@ -162,9 +191,46 @@ class GitHub(commit.Hosting):
             flags.append(f"{name}={value}")
 
         data = self.json_from("/releases", *flags, method="POST", default={})
-        html_url = cast(Optional[str], data.get("html_url"))
+        return self._release_from_json(data, draft)
 
-        return commit.ReleaseInfo(draft_url=html_url)
+    def locate_release(self, release_name: str) -> Optional[commit.ReleaseInfo]:
+        releases = self.json_from("/releases", default=[], ro_call=True)
+        for release in releases:
+            if release.get("name") == release_name:
+                return self._release_from_json(release)
+
+        return None
+
+    def upload_to_release(
+        self,
+        release: commit.ReleaseInfo,
+        directory: str,
+        names: list[str],
+    ):
+        with cmd.cd(directory):
+            return self._run(
+                "gh",
+                "release",
+                "upload",
+                release.tag or release.ref or "",
+                *names,
+                "--clobber",
+            )
+
+    def publish(self, release: commit.ReleaseInfo) -> commit.ReleaseInfo:
+        if not isinstance(release, ReleaseInfo):
+            return commit.ReleaseInfo(is_draft=False)
+
+        release_id = release.id
+        data = self.json_from(
+            f"/releases/{release_id}",
+            "-f",
+            "draft=false",
+            "-F",
+            "make_latest=legacy",
+            method="PATCH",
+        )
+        return self._release_from_json(data)
 
     @staticmethod
     def from_repo(git: commit.Git, remote: Optional[str] = None):

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/log/release.py

@@ -130,8 +130,9 @@ def add_release(
     git.annotated_tag(setup.curr_tag, commit_message)
 
     if hosting.is_active:
-        draft_url = hosting.add_release(changelog, setup, git, draft).draft_url
-        if draft_url:
-            rt.message("Visit draft at", draft_url, level=env.Msg.ALWAYS)
+        info = hosting.add_release(changelog, setup, git, draft)
+        if info.url:
+            msg = "Visit draft at" if info.is_draft else "Visit release at"
+            rt.message(msg, info.url, level=env.Msg.ALWAYS)
 
     return setup.curr_tag

{proj_flow-0.11.3 → proj_flow-0.13.0}/src/proj_flow/template/layers/base/.flow/config.yml

@@ -18,17 +18,9 @@ compiler:
     gcc: [ gcc, g++ ]
   os-default: { ubuntu: gcc, windows: msvc }
 
-lts:
-  ubuntu:
-    - ubuntu-20.04
-    - ubuntu-22.04
-    - ubuntu-24.04
-
 postproc:
   exclude:
-    - { github_os: ubuntu-20.04, sanitizer: true }
     - { github_os: ubuntu-24.04, sanitizer: true }
-    - { github_os: ubuntu-20.04, compiler: clang }
 
 
 shortcuts: