path-sync 0.4.1__tar.gz → 0.6.0__tar.gz

{path_sync-0.4.1 → path_sync-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: path-sync
-Version: 0.4.1
+Version: 0.6.0
 Summary: Sync files from a source repo to multiple destination repos
 Author-email: EspenAlbert <espen.albert1@gmail.com>
 License-Expression: MIT
@@ -77,13 +77,14 @@ By default, prompts before each git operation. See [Usage Scenarios](#usage-scen
 | `-d dest1,dest2` | Filter specific destinations |
 | `--dry-run` | Preview without writing (requires existing repos) |
 | `-y, --no-prompt` | Skip confirmations (for CI) |
-| `--local` | No git ops after sync (no commit/push/PR) |
+| `--skip-commit` | No git ops after sync (no commit/push/PR). Alias: `--local` |
 | `--no-checkout` | Skip branch switching (assumes already on correct branch) |
 | `--checkout-from-default` | Reset to origin/default before sync |
 | `--no-pr` | Push but skip PR creation |
 | `--force-overwrite` | Overwrite files even if header removed (opted out) |
 | `--detailed-exit-code` | Exit 0=no changes, 1=changes, 2=error |
 | `--skip-orphan-cleanup` | Skip deletion of orphaned synced files |
+| `--skip-verify` | Skip verification steps after syncing |
 | `--pr-title` | Override PR title (supports `{name}`, `{dest_name}`) |
 | `--pr-labels` | Comma-separated PR labels |
 | `--pr-reviewers` | Comma-separated PR reviewers |
@@ -106,12 +107,12 @@ Options:
 | Interactive sync | `copy -n cfg` |
 | CI fresh sync | `copy -n cfg --checkout-from-default -y` |
 | Local preview | `copy -n cfg --dry-run` |
-| Local test files | `copy -n cfg --local` |
+| Local test files | `copy -n cfg --skip-commit` |
 | Already on branch | `copy -n cfg --no-checkout` |
 | Push, manual PR | `copy -n cfg --no-pr -y` |
 | Force opted-out | `copy -n cfg --force-overwrite` |
 
-**Interactive prompt behavior**: Declining the checkout prompt syncs files but skips commit/push/PR (same as `--local`). Use `--no-checkout` when you're already on the correct branch and want to proceed with git operations.
+**Interactive prompt behavior**: Each git operation (checkout, commit, push, PR) prompts independently. Use `--no-checkout` to skip the branch switch prompt. Use `--skip-commit` to skip all git operations after sync.
 
 ## Section Markers
 
@@ -139,6 +140,36 @@ destinations:
       justfile: [coverage]  # keep local coverage recipe
 ```
 
+## Wrapping Synced Files
+
+For files without section markers, `wrap_synced_files` automatically wraps content in a `synced` section. This lets destinations add content before/after the synced content.
+
+**Without wrapping** (default):
+```python
+# path-sync copy -n myconfig
+def hello():
+    pass
+```
+
+**With wrapping** (`wrap_synced_files: true`):
+```python
+# path-sync copy -n myconfig
+# === DO_NOT_EDIT: path-sync synced ===
+def hello():
+    pass
+# === OK_EDIT: path-sync synced ===
+```
+
+Destinations can add content outside the section markers. Per-path override via `wrap: false`:
+
+```yaml
+wrap_synced_files: true
+paths:
+  - src_path: templates/base.py     # wrapped
+  - src_path: .editorconfig
+    wrap: false                     # not wrapped
+```
+
 ## Skipping Files per Destination
 
 Use `skip_file_patterns` to exclude files for specific destinations. Patterns match against the **destination path** (after `dest_path` remapping):
@@ -195,6 +226,8 @@ destinations:
 | `destinations` | Target repos with sync settings |
 | `header_config` | Comment style per extension (has defaults) |
 | `pr_defaults` | PR title, labels, reviewers, assignees |
+| `wrap_synced_files` | Wrap synced files in section markers (default: `false`) |
+| `verify` | Verification steps to run after syncing (see [Verify Steps](#verify-steps-in-copy)) |
 
 **Path options**:
 
@@ -205,6 +238,7 @@ destinations:
 | `sync_mode` | `sync` (default), `replace`, or `scaffold` |
 | `exclude_dirs` | Directory names to skip (defaults: `__pycache__`, `.git`, `.venv`, etc.) |
 | `exclude_file_patterns` | Filename patterns to skip, supports globs (`*.pyc`, `test_*.py`) |
+| `wrap` | Override global `wrap_synced_files` for this path (`true`/`false`) |
 
 **Destination options**:
 
@@ -217,6 +251,37 @@ destinations:
 | `default_branch` | Default branch to compare against (defaults to `main`) |
 | `skip_sections` | Map of `{dest_path: [section_ids]}` to preserve locally |
 | `skip_file_patterns` | Patterns to skip for this destination (matches dest path, fnmatch syntax) |
+| `verify` | Per-destination verify config (overrides source-level verify) |
+
+## Verify Steps in Copy
+
+Run verification steps after syncing files. Synced files are committed first, then verify steps run and can make additional commits.
+
+```yaml
+name: myconfig
+verify:
+  on_fail: warn  # default: warn (also: skip, fail)
+  steps:
+    - run: just fmt
+      commit:
+        message: "style: format synced files"
+        add_paths: ["."]
+      on_fail: warn
+    - run: just test
+```
+
+Per-destination override:
+
+```yaml
+destinations:
+  - name: dest1
+    dest_path_relative: ../dest1
+    verify:
+      steps:
+        - run: npm run build
+```
+
+Use `--skip-verify` to disable verification steps.
 
 ## Header Format
 
@@ -314,6 +379,109 @@ Add as repository secret: `GH_PAT`
 | `GraphQL: Resource not accessible` | Use GH_PAT, not GITHUB_TOKEN |
 | `HTTP 422: Required status check` | Exclude `sync/*` from branch protection |
 
+## Dependency Updates
+
+The `dep-update` command runs dependency updates across multiple repositories. It clones repos, runs update commands, verifies changes, and creates PRs.
+
+### Quick Start
+
+```bash
+# Create config at .github/myconfig.dep.yaml (see example below)
+# Then run:
+path-sync dep-update -n myconfig
+
+# Preview without creating PRs
+path-sync dep-update -n myconfig --dry-run
+
+# Filter specific destinations
+path-sync dep-update -n myconfig -d repo1,repo2
+```
+
+### Dep Config Reference
+
+**Config file**: `.github/{name}.dep.yaml`
+
+```yaml
+name: uv-deps
+from_config: python-template  # references .github/python-template.src.yaml for destinations
+exclude_destinations:
+  - path-sync  # skip self
+
+updates:
+  - command: uv lock --upgrade
+  - workdir: packages/sub  # optional subdirectory
+    command: uv lock --upgrade
+
+verify:
+  on_fail: skip  # default strategy: skip, fail, warn
+  steps:
+    - run: uv sync
+    - run: just fmt
+      commit:
+        message: "chore: format after update"
+        add_paths: [".", "!uv.lock"]  # ! prefix excludes
+      on_fail: warn
+    - run: just test
+
+pr:
+  branch: deps/uv-lock-update
+  title: "chore(deps): update uv.lock"
+  labels: [dependencies]
+  reviewers: []  # optional
+  assignees: []  # optional
+  auto_merge: true
+```
+
+| Field | Description |
+|-------|-------------|
+| `from_config` | Source config name for destination list |
+| `include_destinations` | Only process these destinations |
+| `exclude_destinations` | Skip these destinations |
+| `updates` | Commands to run (in order) |
+| `verify.on_fail` | Default failure strategy: `skip`, `fail`, `warn` |
+| `verify.steps` | Verification commands with optional commit/on_fail |
+| `pr.auto_merge` | Enable GitHub auto-merge after PR creation |
+
+### CLI Flags
+
+| Flag | Description |
+|------|-------------|
+| `-n, --name` | Config name (required) |
+| `-d, --dest` | Filter destinations (comma-separated) |
+| `--work-dir` | Clone directory for repos without `dest_path_relative` |
+| `--dry-run` | Preview without creating PRs |
+| `--skip-verify` | Skip verification steps |
+| `--pr-reviewers` | Override PR reviewers (comma-separated) |
+| `--pr-assignees` | Override PR assignees (comma-separated) |
+
+### Failure Strategies
+
+- **skip**: Skip PR for this repo, continue with others (default)
+- **fail**: Stop all processing immediately
+- **warn**: Create PR anyway with warning in body
+
+Per-step `on_fail` overrides the verify-level default.
+
+### GitHub Actions
+
+```yaml
+name: dep-update
+on:
+  schedule:
+    - cron: "0 6 * * 1"  # Weekly Monday
+  workflow_dispatch:
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uvx path-sync dep-update -n myconfig
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT }}
+```
+
 ## Alternatives Considered
 
 | Tool | Why Not |

{path_sync-0.4.1 → path_sync-0.6.0}/README.md

@@ -59,13 +59,14 @@ By default, prompts before each git operation. See [Usage Scenarios](#usage-scen
 | `-d dest1,dest2` | Filter specific destinations |
 | `--dry-run` | Preview without writing (requires existing repos) |
 | `-y, --no-prompt` | Skip confirmations (for CI) |
-| `--local` | No git ops after sync (no commit/push/PR) |
+| `--skip-commit` | No git ops after sync (no commit/push/PR). Alias: `--local` |
 | `--no-checkout` | Skip branch switching (assumes already on correct branch) |
 | `--checkout-from-default` | Reset to origin/default before sync |
 | `--no-pr` | Push but skip PR creation |
 | `--force-overwrite` | Overwrite files even if header removed (opted out) |
 | `--detailed-exit-code` | Exit 0=no changes, 1=changes, 2=error |
 | `--skip-orphan-cleanup` | Skip deletion of orphaned synced files |
+| `--skip-verify` | Skip verification steps after syncing |
 | `--pr-title` | Override PR title (supports `{name}`, `{dest_name}`) |
 | `--pr-labels` | Comma-separated PR labels |
 | `--pr-reviewers` | Comma-separated PR reviewers |
@@ -88,12 +89,12 @@ Options:
 | Interactive sync | `copy -n cfg` |
 | CI fresh sync | `copy -n cfg --checkout-from-default -y` |
 | Local preview | `copy -n cfg --dry-run` |
-| Local test files | `copy -n cfg --local` |
+| Local test files | `copy -n cfg --skip-commit` |
 | Already on branch | `copy -n cfg --no-checkout` |
 | Push, manual PR | `copy -n cfg --no-pr -y` |
 | Force opted-out | `copy -n cfg --force-overwrite` |
 
-**Interactive prompt behavior**: Declining the checkout prompt syncs files but skips commit/push/PR (same as `--local`). Use `--no-checkout` when you're already on the correct branch and want to proceed with git operations.
+**Interactive prompt behavior**: Each git operation (checkout, commit, push, PR) prompts independently. Use `--no-checkout` to skip the branch switch prompt. Use `--skip-commit` to skip all git operations after sync.
 
 ## Section Markers
 
@@ -121,6 +122,36 @@ destinations:
       justfile: [coverage]  # keep local coverage recipe
 ```
 
+## Wrapping Synced Files
+
+For files without section markers, `wrap_synced_files` automatically wraps content in a `synced` section. This lets destinations add content before/after the synced content.
+
+**Without wrapping** (default):
+```python
+# path-sync copy -n myconfig
+def hello():
+    pass
+```
+
+**With wrapping** (`wrap_synced_files: true`):
+```python
+# path-sync copy -n myconfig
+# === DO_NOT_EDIT: path-sync synced ===
+def hello():
+    pass
+# === OK_EDIT: path-sync synced ===
+```
+
+Destinations can add content outside the section markers. Per-path override via `wrap: false`:
+
+```yaml
+wrap_synced_files: true
+paths:
+  - src_path: templates/base.py     # wrapped
+  - src_path: .editorconfig
+    wrap: false                     # not wrapped
+```
+
 ## Skipping Files per Destination
 
 Use `skip_file_patterns` to exclude files for specific destinations. Patterns match against the **destination path** (after `dest_path` remapping):
@@ -177,6 +208,8 @@ destinations:
 | `destinations` | Target repos with sync settings |
 | `header_config` | Comment style per extension (has defaults) |
 | `pr_defaults` | PR title, labels, reviewers, assignees |
+| `wrap_synced_files` | Wrap synced files in section markers (default: `false`) |
+| `verify` | Verification steps to run after syncing (see [Verify Steps](#verify-steps-in-copy)) |
 
 **Path options**:
 
@@ -187,6 +220,7 @@ destinations:
 | `sync_mode` | `sync` (default), `replace`, or `scaffold` |
 | `exclude_dirs` | Directory names to skip (defaults: `__pycache__`, `.git`, `.venv`, etc.) |
 | `exclude_file_patterns` | Filename patterns to skip, supports globs (`*.pyc`, `test_*.py`) |
+| `wrap` | Override global `wrap_synced_files` for this path (`true`/`false`) |
 
 **Destination options**:
 
@@ -199,6 +233,37 @@ destinations:
 | `default_branch` | Default branch to compare against (defaults to `main`) |
 | `skip_sections` | Map of `{dest_path: [section_ids]}` to preserve locally |
 | `skip_file_patterns` | Patterns to skip for this destination (matches dest path, fnmatch syntax) |
+| `verify` | Per-destination verify config (overrides source-level verify) |
+
+## Verify Steps in Copy
+
+Run verification steps after syncing files. Synced files are committed first, then verify steps run and can make additional commits.
+
+```yaml
+name: myconfig
+verify:
+  on_fail: warn  # default: warn (also: skip, fail)
+  steps:
+    - run: just fmt
+      commit:
+        message: "style: format synced files"
+        add_paths: ["."]
+      on_fail: warn
+    - run: just test
+```
+
+Per-destination override:
+
+```yaml
+destinations:
+  - name: dest1
+    dest_path_relative: ../dest1
+    verify:
+      steps:
+        - run: npm run build
+```
+
+Use `--skip-verify` to disable verification steps.
 
 ## Header Format
 
@@ -296,6 +361,109 @@ Add as repository secret: `GH_PAT`
 | `GraphQL: Resource not accessible` | Use GH_PAT, not GITHUB_TOKEN |
 | `HTTP 422: Required status check` | Exclude `sync/*` from branch protection |
 
+## Dependency Updates
+
+The `dep-update` command runs dependency updates across multiple repositories. It clones repos, runs update commands, verifies changes, and creates PRs.
+
+### Quick Start
+
+```bash
+# Create config at .github/myconfig.dep.yaml (see example below)
+# Then run:
+path-sync dep-update -n myconfig
+
+# Preview without creating PRs
+path-sync dep-update -n myconfig --dry-run
+
+# Filter specific destinations
+path-sync dep-update -n myconfig -d repo1,repo2
+```
+
+### Dep Config Reference
+
+**Config file**: `.github/{name}.dep.yaml`
+
+```yaml
+name: uv-deps
+from_config: python-template  # references .github/python-template.src.yaml for destinations
+exclude_destinations:
+  - path-sync  # skip self
+
+updates:
+  - command: uv lock --upgrade
+  - workdir: packages/sub  # optional subdirectory
+    command: uv lock --upgrade
+
+verify:
+  on_fail: skip  # default strategy: skip, fail, warn
+  steps:
+    - run: uv sync
+    - run: just fmt
+      commit:
+        message: "chore: format after update"
+        add_paths: [".", "!uv.lock"]  # ! prefix excludes
+      on_fail: warn
+    - run: just test
+
+pr:
+  branch: deps/uv-lock-update
+  title: "chore(deps): update uv.lock"
+  labels: [dependencies]
+  reviewers: []  # optional
+  assignees: []  # optional
+  auto_merge: true
+```
+
+| Field | Description |
+|-------|-------------|
+| `from_config` | Source config name for destination list |
+| `include_destinations` | Only process these destinations |
+| `exclude_destinations` | Skip these destinations |
+| `updates` | Commands to run (in order) |
+| `verify.on_fail` | Default failure strategy: `skip`, `fail`, `warn` |
+| `verify.steps` | Verification commands with optional commit/on_fail |
+| `pr.auto_merge` | Enable GitHub auto-merge after PR creation |
+
+### CLI Flags
+
+| Flag | Description |
+|------|-------------|
+| `-n, --name` | Config name (required) |
+| `-d, --dest` | Filter destinations (comma-separated) |
+| `--work-dir` | Clone directory for repos without `dest_path_relative` |
+| `--dry-run` | Preview without creating PRs |
+| `--skip-verify` | Skip verification steps |
+| `--pr-reviewers` | Override PR reviewers (comma-separated) |
+| `--pr-assignees` | Override PR assignees (comma-separated) |
+
+### Failure Strategies
+
+- **skip**: Skip PR for this repo, continue with others (default)
+- **fail**: Stop all processing immediately
+- **warn**: Create PR anyway with warning in body
+
+Per-step `on_fail` overrides the verify-level default.
+
+### GitHub Actions
+
+```yaml
+name: dep-update
+on:
+  schedule:
+    - cron: "0 6 * * 1"  # Weekly Monday
+  workflow_dispatch:
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uvx path-sync dep-update -n myconfig
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT }}
+```
+
 ## Alternatives Considered
 
 | Tool | Why Not |

{path_sync-0.4.1 → path_sync-0.6.0}/path_sync/__init__.py

@@ -1,12 +1,14 @@
 # Generated by pkg-ext
 # flake8: noqa
-from path_sync import config
 from path_sync import copy
 from path_sync import dep_update
+from path_sync import validate_no_changes
+from path_sync import config
 
-VERSION = "0.4.1"
+VERSION = "0.6.0"
 __all__ = [
-    "config",
     "copy",
     "dep_update",
+    "validate_no_changes",
+    "config",
 ]