path-sync 0.3.4__tar.gz → 0.4.0__tar.gz

{path_sync-0.3.4 → path_sync-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: path-sync
-Version: 0.3.4
+Version: 0.4.0
 Summary: Sync files from a source repo to multiple destination repos
 Author-email: EspenAlbert <espen.albert1@gmail.com>
 License-Expression: MIT
@@ -13,11 +13,16 @@ Requires-Dist: gitpython>=3.1.0
 Requires-Dist: pydantic>=2.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: typer>=0.16.0
-Requires-Dist: zero-3rdparty>=0.101.1
+Requires-Dist: zero-3rdparty>=0.102.0
 Description-Content-Type: text/markdown
 
 # path-sync
 
+[![PyPI](https://img.shields.io/pypi/v/path-sync)](https://pypi.org/project/path-sync/)
+[![GitHub](https://img.shields.io/github/license/EspenAlbert/path-sync)](https://github.com/EspenAlbert/path-sync)
+[![codecov](https://codecov.io/gh/EspenAlbert/path-sync/graph/badge.svg)](https://codecov.io/gh/EspenAlbert/path-sync)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://espenalbert.github.io/path-sync/)
+
 Sync files from a source repo to multiple destination repos.
 
 ## Overview

{path_sync-0.3.4 → path_sync-0.4.0}/README.md

@@ -1,5 +1,10 @@
 # path-sync
 
+[![PyPI](https://img.shields.io/pypi/v/path-sync)](https://pypi.org/project/path-sync/)
+[![GitHub](https://img.shields.io/github/license/EspenAlbert/path-sync)](https://github.com/EspenAlbert/path-sync)
+[![codecov](https://codecov.io/gh/EspenAlbert/path-sync/graph/badge.svg)](https://codecov.io/gh/EspenAlbert/path-sync)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://espenalbert.github.io/path-sync/)
+
 Sync files from a source repo to multiple destination repos.
 
 ## Overview

{path_sync-0.3.4 → path_sync-0.4.0}/path_sync/__init__.py

@@ -1,10 +1,12 @@
 # Generated by pkg-ext
 # flake8: noqa
-from path_sync import copy
 from path_sync import config
+from path_sync import copy
+from path_sync import dep_update
 
-VERSION = "0.3.4"
+VERSION = "0.4.0"
 __all__ = [
-    "copy",
     "config",
+    "copy",
+    "dep_update",
 ]

{path_sync-0.3.4 → path_sync-0.4.0}/path_sync/__main__.py

@@ -1,6 +1,6 @@
 import logging
 
-from path_sync._internal import cmd_boot, cmd_copy, cmd_validate  # noqa: F401
+from path_sync._internal import cmd_boot, cmd_copy, cmd_dep_update, cmd_validate  # noqa: F401
 from path_sync._internal.models import LOG_FORMAT
 from path_sync._internal.typer_app import app
 

{path_sync-0.3.4 → path_sync-0.4.0}/path_sync/_internal/cmd_copy.py

@@ -237,10 +237,10 @@ def _sync_destination(
 
     # --no-checkout means "I'm already on the right branch"
     # Prompt decline means "skip git operations for this run"
-    if opts.no_checkout:
-        skip_git_ops = False
-    elif opts.dry_run:
+    if opts.dry_run:
         skip_git_ops = True
+    elif opts.no_checkout:
+        skip_git_ops = False
     elif _prompt(f"Switch {dest.name} to {copy_branch}?", opts.no_prompt):
         git_ops.prepare_copy_branch(
             repo=dest_repo,

path_sync-0.4.0/path_sync/_internal/cmd_dep_update.py

@@ -0,0 +1,250 @@
+from __future__ import annotations
+
+import logging
+import subprocess
+from dataclasses import dataclass, field
+from enum import StrEnum
+from pathlib import Path
+
+import typer
+from git import Repo
+
+from path_sync._internal import git_ops
+from path_sync._internal.models import Destination, find_repo_root
+from path_sync._internal.models_dep import (
+    DepConfig,
+    OnFailStrategy,
+    UpdateEntry,
+    VerifyConfig,
+    resolve_dep_config_path,
+)
+from path_sync._internal.typer_app import app
+from path_sync._internal.yaml_utils import load_yaml_model
+
+logger = logging.getLogger(__name__)
+
+MAX_STDERR_LINES = 20
+
+
+class Status(StrEnum):
+    PASSED = "passed"
+    SKIPPED = "skipped"
+    WARN = "warn"
+    NO_CHANGES = "no_changes"
+    FAILED = "failed"
+
+
+@dataclass
+class StepFailure:
+    step: str
+    returncode: int
+    stderr: str
+    on_fail: OnFailStrategy
+
+    @classmethod
+    def from_error(cls, step: str, e: subprocess.CalledProcessError, on_fail: OnFailStrategy) -> StepFailure:
+        stderr = _truncate_stderr(e.stderr or "", MAX_STDERR_LINES)
+        return cls(step=step, returncode=e.returncode, stderr=stderr, on_fail=on_fail)
+
+
+@dataclass
+class RepoResult:
+    dest: Destination
+    repo_path: Path
+    status: Status
+    failures: list[StepFailure] = field(default_factory=list)
+
+
+def _truncate_stderr(text: str, max_lines: int) -> str:
+    lines = text.strip().splitlines()
+    if len(lines) <= max_lines:
+        return text.strip()
+    skipped = len(lines) - max_lines
+    return f"... ({skipped} lines skipped)\n" + "\n".join(lines[-max_lines:])
+
+
+@app.command()
+def dep_update(
+    name: str = typer.Option(..., "-n", "--name", help="Config name"),
+    dest_filter: str = typer.Option("", "-d", "--dest", help="Filter destinations (comma-separated)"),
+    work_dir: str = typer.Option("", "--work-dir", help="Directory for cloning repos"),
+    dry_run: bool = typer.Option(False, "--dry-run", help="Preview without creating PRs"),
+    skip_verify: bool = typer.Option(False, "--skip-verify", help="Skip verification steps"),
+    src_root_opt: str = typer.Option("", "--src-root", help="Source repo root"),
+) -> None:
+    """Run dependency updates across repositories."""
+    src_root = Path(src_root_opt) if src_root_opt else find_repo_root(Path.cwd())
+    config_path = resolve_dep_config_path(src_root, name)
+    if not config_path.exists():
+        logger.error(f"Config not found: {config_path}")
+        raise typer.Exit(1)
+
+    config = load_yaml_model(config_path, DepConfig)
+    destinations = config.load_destinations(src_root)
+
+    if dest_filter:
+        filter_names = [n.strip() for n in dest_filter.split(",")]
+        destinations = [d for d in destinations if d.name in filter_names]
+
+    results = _update_and_validate(config, destinations, src_root, work_dir, skip_verify)
+    _create_prs(config, results, dry_run)
+
+    if any(r.status == Status.SKIPPED for r in results):
+        raise typer.Exit(1)
+
+
+def _update_and_validate(
+    config: DepConfig,
+    destinations: list[Destination],
+    src_root: Path,
+    work_dir: str,
+    skip_verify: bool,
+) -> list[RepoResult]:
+    results: list[RepoResult] = []
+
+    for dest in destinations:
+        result = _process_single_repo(config, dest, src_root, work_dir, skip_verify)
+
+        if result.status == Status.FAILED:
+            logger.error(f"{dest.name}: Verification failed, stopping")
+            raise typer.Exit(1)
+
+        if result.status != Status.NO_CHANGES:
+            results.append(result)
+
+    return results
+
+
+def _process_single_repo(
+    config: DepConfig,
+    dest: Destination,
+    src_root: Path,
+    work_dir: str,
+    skip_verify: bool,
+) -> RepoResult:
+    logger.info(f"Processing {dest.name}...")
+    repo_path = _resolve_repo_path(dest, src_root, work_dir)
+    repo = _ensure_repo(dest, repo_path)
+    git_ops.prepare_copy_branch(repo, dest.default_branch, config.pr.branch, from_default=True)
+
+    if failure := _run_updates(config.updates, repo_path):
+        logger.warning(f"{dest.name}: Update failed with exit code {failure.returncode}")
+        return RepoResult(dest, repo_path, Status.SKIPPED, failures=[failure])
+
+    if not git_ops.has_changes(repo):
+        logger.info(f"{dest.name}: No changes, skipping")
+        return RepoResult(dest, repo_path, Status.NO_CHANGES)
+
+    git_ops.commit_changes(repo, config.pr.title)
+
+    if skip_verify:
+        return RepoResult(dest, repo_path, Status.PASSED)
+
+    return _verify_repo(repo, repo_path, config.verify, dest)
+
+
+def _run_updates(updates: list[UpdateEntry], repo_path: Path) -> StepFailure | None:
+    """Returns StepFailure on failure, None on success."""
+    try:
+        for update in updates:
+            _run_command(update.command, repo_path / update.workdir)
+        return None
+    except subprocess.CalledProcessError as e:
+        return StepFailure.from_error(e.cmd, e, OnFailStrategy.SKIP)
+
+
+def _verify_repo(repo: Repo, repo_path: Path, verify: VerifyConfig, dest: Destination) -> RepoResult:
+    status, failures = _run_verify_steps(repo, repo_path, verify)
+    return RepoResult(dest, repo_path, status, failures)
+
+
+def _create_prs(config: DepConfig, results: list[RepoResult], dry_run: bool) -> None:
+    for result in results:
+        if result.status == Status.SKIPPED:
+            continue
+
+        if dry_run:
+            logger.info(f"[DRY RUN] Would create PR for {result.dest.name}")
+            continue
+
+        repo = git_ops.get_repo(result.repo_path)
+        git_ops.push_branch(repo, config.pr.branch, force=True)
+
+        body = _build_pr_body(result.failures)
+        git_ops.create_or_update_pr(
+            result.repo_path,
+            config.pr.branch,
+            config.pr.title,
+            body,
+            config.pr.labels or None,
+            auto_merge=config.pr.auto_merge,
+        )
+        logger.info(f"{result.dest.name}: PR created/updated")
+
+
+def _resolve_repo_path(dest: Destination, src_root: Path, work_dir: str) -> Path:
+    if dest.dest_path_relative:
+        return (src_root / dest.dest_path_relative).resolve()
+    if not work_dir:
+        raise typer.BadParameter(f"No dest_path_relative for {dest.name}, --work-dir required")
+    return Path(work_dir) / dest.name
+
+
+def _ensure_repo(dest: Destination, repo_path: Path):
+    if repo_path.exists() and git_ops.is_git_repo(repo_path):
+        return git_ops.get_repo(repo_path)
+    if not dest.repo_url:
+        raise ValueError(f"Dest {dest.name} not found at {repo_path} and no repo_url configured")
+    return git_ops.clone_repo(dest.repo_url, repo_path)
+
+
+def _run_command(cmd: str, cwd: Path) -> None:
+    logger.info(f"Running: {cmd}")
+    result = subprocess.run(cmd, shell=True, cwd=cwd, capture_output=True, text=True)
+    if result.returncode != 0:
+        stderr = result.stderr.strip()
+        logger.error(f"Command failed '{cmd}' in {cwd}: {stderr}")
+        raise subprocess.CalledProcessError(result.returncode, cmd, output=result.stdout, stderr=stderr)
+
+
+def _run_verify_steps(
+    repo: Repo,
+    repo_path: Path,
+    verify: VerifyConfig,
+) -> tuple[Status, list[StepFailure]]:
+    failures: list[StepFailure] = []
+
+    for step in verify.steps:
+        on_fail = step.on_fail or verify.on_fail
+
+        try:
+            _run_command(step.run, repo_path)
+        except subprocess.CalledProcessError as e:
+            failure = StepFailure.from_error(step.run, e, on_fail)
+            match on_fail:
+                case OnFailStrategy.FAIL:
+                    return (Status.FAILED, [failure])
+                case OnFailStrategy.SKIP:
+                    return (Status.SKIPPED, [failure])
+                case OnFailStrategy.WARN:
+                    failures.append(failure)
+                    continue
+
+        if step.commit:
+            git_ops.stage_and_commit(repo, step.commit.add_paths, step.commit.message)
+
+    return (Status.WARN if failures else Status.PASSED, failures)
+
+
+def _build_pr_body(failures: list[StepFailure]) -> str:
+    body = "Automated dependency update."
+    if not failures:
+        return body
+
+    body += "\n\n---\n## Verification Issues\n"
+    for f in failures:
+        body += f"\n### `{f.step}` (strategy: {f.on_fail})\n"
+        body += f"**Exit code:** {f.returncode}\n"
+        if f.stderr:
+            body += f"\n```\n{f.stderr}\n```\n"
+    return body

{path_sync-0.3.4 → path_sync-0.4.0}/path_sync/_internal/git_ops.py

@@ -107,6 +107,22 @@ def commit_changes(repo: Repo, message: str) -> None:
         logger.info(f"Committed: {message}")
 
 
+def stage_and_commit(repo: Repo, add_paths: list[str], message: str) -> bool:
+    """Stage specified paths and commit if there are changes. Returns True if a commit was made."""
+    include = [p for p in add_paths if not p.startswith("!")]
+    exclude = [p[1:] for p in add_paths if p.startswith("!")]
+    for path in include:
+        repo.git.add(path)
+    for path in exclude:
+        repo.git.reset("HEAD", "--", path)
+    if not repo.is_dirty(index=True):
+        return False
+    _ensure_git_user(repo)
+    repo.git.commit("-m", message)
+    logger.info(f"Committed: {message}")
+    return True
+
+
 def _ensure_git_user(repo: Repo) -> None:
     """Configure git user if not already set."""
     try:
@@ -140,6 +156,7 @@ def create_or_update_pr(
     labels: list[str] | None = None,
     reviewers: list[str] | None = None,
     assignees: list[str] | None = None,
+    auto_merge: bool = False,
 ) -> str:
     cmd = ["gh", "pr", "create", "--head", branch, "--title", title]
     cmd.extend(["--body", body or ""])
@@ -155,10 +172,24 @@ def create_or_update_pr(
         if "already exists" in result.stderr:
             logger.info("PR already exists, updating body")
             update_pr_body(repo_path, branch, body)
+            if auto_merge:
+                _enable_auto_merge(repo_path, branch)
             return ""
         raise RuntimeError(f"Failed to create PR: {result.stderr}")
-    logger.info(f"Created PR: {result.stdout.strip()}")
-    return result.stdout.strip()
+    pr_url = result.stdout.strip()
+    logger.info(f"Created PR: {pr_url}")
+    if auto_merge:
+        _enable_auto_merge(repo_path, pr_url)
+    return pr_url
+
+
+def _enable_auto_merge(repo_path: Path, pr_ref: str) -> None:
+    cmd = ["gh", "pr", "merge", "--auto", "--squash", pr_ref]
+    result = subprocess.run(cmd, cwd=repo_path, capture_output=True, text=True)
+    if result.returncode != 0:
+        logger.warning(f"Auto-merge failed (branch protection may not be configured): {result.stderr}")
+    else:
+        logger.info(f"Enabled auto-merge for {pr_ref}")
 
 
 def file_has_git_changes(repo: Repo, file_path: Path, base_ref: str = "HEAD") -> bool:

path_sync-0.4.0/path_sync/_internal/models_dep.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from enum import StrEnum
+from pathlib import Path
+from typing import ClassVar
+
+from pydantic import BaseModel, Field
+
+from path_sync._internal.models import Destination, SrcConfig, resolve_config_path
+from path_sync._internal.yaml_utils import load_yaml_model
+
+
+class OnFailStrategy(StrEnum):
+    SKIP = "skip"
+    FAIL = "fail"
+    WARN = "warn"
+
+
+class CommitConfig(BaseModel):
+    message: str
+    add_paths: list[str] = Field(default_factory=lambda: ["."])
+
+
+class VerifyStep(BaseModel):
+    run: str
+    commit: CommitConfig | None = None
+    on_fail: OnFailStrategy | None = None
+
+
+class VerifyConfig(BaseModel):
+    on_fail: OnFailStrategy = OnFailStrategy.SKIP
+    steps: list[VerifyStep] = Field(default_factory=list)
+
+
+class UpdateEntry(BaseModel):
+    workdir: str = "."
+    command: str
+
+
+class PRConfig(BaseModel):
+    branch: str
+    title: str
+    labels: list[str] = Field(default_factory=list)
+    auto_merge: bool = False
+
+
+class DepConfig(BaseModel):
+    CONFIG_EXT: ClassVar[str] = ".dep.yaml"
+
+    name: str
+    from_config: str
+    include_destinations: list[str] = Field(default_factory=list)
+    exclude_destinations: list[str] = Field(default_factory=list)
+    updates: list[UpdateEntry]
+    verify: VerifyConfig = Field(default_factory=VerifyConfig)
+    pr: PRConfig
+
+    def load_destinations(self, repo_root: Path) -> list[Destination]:
+        src_config_path = resolve_config_path(repo_root, self.from_config)
+        src_config = load_yaml_model(src_config_path, SrcConfig)
+        destinations = src_config.destinations
+        if self.include_destinations:
+            destinations = [d for d in destinations if d.name in self.include_destinations]
+        if self.exclude_destinations:
+            destinations = [d for d in destinations if d.name not in self.exclude_destinations]
+        return destinations
+
+
+def resolve_dep_config_path(repo_root: Path, name: str) -> Path:
+    return repo_root / ".github" / f"{name}{DepConfig.CONFIG_EXT}"

{path_sync-0.3.4 → path_sync-0.4.0}/path_sync/_internal/validation.py

@@ -31,6 +31,7 @@ def validate_no_unauthorized_changes(
     """Find files with unauthorized changes in DO_NOT_EDIT sections.
 
     Returns 'path:section_id' for section changes or 'path' for full-file.
+    Missing sections (user opted out) are warned but not treated as errors.
     """
     repo = git_ops.get_repo(repo_root)
     base_ref = f"origin/{default_branch}"
@@ -55,8 +56,10 @@ def validate_no_unauthorized_changes(
 
         if baseline_has_sections:
             file_skip = skip.get(rel_path, set())
-            changed_ids = sections.compare_sections(baseline_content, current_content, path, file_skip)
-            unauthorized.extend(f"{rel_path}:{sid}" for sid in changed_ids)
+            changes = sections.changed_sections(baseline_content, current_content, path, file_skip)
+            for sid in changes.missing:
+                logger.warning(f"Section '{sid}' removed from {rel_path}, consider updating src.yaml")
+            unauthorized.extend(f"{rel_path}:{sid}" for sid in changes.modified)
         elif current_has_sections:
             unauthorized.append(rel_path)
         else:

path_sync-0.4.0/path_sync/dep_update.py

@@ -0,0 +1,18 @@
+# Generated by pkg-ext
+from path_sync._internal.cmd_dep_update import dep_update as _dep_update
+from path_sync._internal.models_dep import CommitConfig as _CommitConfig
+from path_sync._internal.models_dep import DepConfig as _DepConfig
+from path_sync._internal.models_dep import OnFailStrategy as _OnFailStrategy
+from path_sync._internal.models_dep import PRConfig as _PRConfig
+from path_sync._internal.models_dep import UpdateEntry as _UpdateEntry
+from path_sync._internal.models_dep import VerifyConfig as _VerifyConfig
+from path_sync._internal.models_dep import VerifyStep as _VerifyStep
+
+dep_update = _dep_update
+CommitConfig = _CommitConfig
+DepConfig = _DepConfig
+OnFailStrategy = _OnFailStrategy
+PRConfig = _PRConfig
+UpdateEntry = _UpdateEntry
+VerifyConfig = _VerifyConfig
+VerifyStep = _VerifyStep

{path_sync-0.3.4 → path_sync-0.4.0}/path_sync/sections.py

@@ -4,10 +4,11 @@ from pathlib import Path
 
 from zero_3rdparty.sections import (
     Section,
+    SectionChanges,
     get_comment_config,
 )
 from zero_3rdparty.sections import (
-    compare_sections as _compare_sections,
+    changed_sections as _changed_sections,
 )
 from zero_3rdparty.sections import (
     extract_sections as _extract_sections,
@@ -27,7 +28,8 @@ from zero_3rdparty.sections import (
 
 __all__ = [
     "Section",
-    "compare_sections",
+    "SectionChanges",
+    "changed_sections",
     "extract_sections",
     "has_sections",
     "parse_sections",
@@ -59,14 +61,23 @@ def replace_sections(
     src_sections: dict[str, str],
     path: Path,
     skip_sections: list[str] | None = None,
+    *,
+    keep_deleted_sections: bool = False,
 ) -> str:
-    return _replace_sections(dest_content, src_sections, TOOL_NAME, get_comment_config(path), skip_sections)
+    return _replace_sections(
+        dest_content,
+        src_sections,
+        TOOL_NAME,
+        get_comment_config(path),
+        skip_sections,
+        keep_deleted_sections=keep_deleted_sections,
+    )
 
 
-def compare_sections(
+def changed_sections(
     baseline_content: str,
     current_content: str,
     path: Path,
     skip: set[str] | None = None,
-) -> list[str]:
-    return _compare_sections(baseline_content, current_content, TOOL_NAME, get_comment_config(path), skip, str(path))
+) -> SectionChanges:
+    return _changed_sections(baseline_content, current_content, TOOL_NAME, get_comment_config(path), skip, str(path))

{path_sync-0.3.4 → path_sync-0.4.0}/pyproject.toml

@@ -1,9 +1,8 @@
 # path-sync copy -n python-template
 
-# === OK_EDIT: path-sync header ===
 [project]
 name = "path-sync"
-version = "0.3.4"
+version = "0.4.0"
 description = "Sync files from a source repo to multiple destination repos"
 requires-python = ">=3.13"
 license = "MIT"
@@ -29,7 +28,7 @@ dependencies = [
   "pyyaml>=6.0",
   "typer>=0.16.0",
   "gitpython>=3.1.0",
-  "zero-3rdparty>=0.101.1",
+  "zero-3rdparty>=0.102.0",
 ]
 
 [project.scripts]
@@ -53,6 +52,7 @@ exclude = [
 
 [tool.pkg-ext]
 tag_prefix = "v"
+max_bump_type = "minor"
 
 # === DO_NOT_EDIT: path-sync ruff ===
 [tool.ruff]
@@ -75,6 +75,7 @@ extend-select = ["Q", "RUF100", "C90", "UP", "I", "T"]
 [tool.pytest.ini_options]
 addopts = "-s -vv --log-cli-level=INFO"
 python_files = ["*_test.py", "test_*.py"]
+asyncio_mode = "auto"
 # === OK_EDIT: path-sync pytest ===
 
 # === DO_NOT_EDIT: path-sync coverage ===
@@ -88,7 +89,9 @@ exclude_lines = ["no cov", "if __name__ == .__main__.:"]
 dev = [
   "pyright>=1.1",
   "pytest>=9.0",
+  "pytest-asyncio>=0.24",
   "pytest-cov>=7.0",
+  "pytest-regressions>=2.6",
   "ruff>=0.14",
 ]
 # === OK_EDIT: path-sync dev ===
@@ -98,3 +101,7 @@ docs = [
   "mkdocs-material>=9.5",
 ]
 # === OK_EDIT: path-sync docs ===
+
+# === DO_NOT_EDIT: path-sync release ===
+release = ["pkg-ext"]
+# === OK_EDIT: path-sync release ===