Breadway/bread
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
bread/bread-sync/EXTRACTION.md
Breadway cc456b78fe refactor: remove remote module install, extract bread-sync, make CI real 
Security:
- Remove `bread modules install github:…`. Remote fetch pulled unreviewed
  third-party Lua and ran it with full bread.exec() privileges in an
  unsandboxed runtime. Module install is now local-only; parse_source
  rejects github:/git: with an explicit message.

bread-sync extracted from the workspace (parked for its own project):
- Removed from workspace members (now excluded); see bread-sync/EXTRACTION.md
- Removed the entire `bread sync` CLI surface and now-unused deps
  (bread-sync, reqwest, tar, flate2; tempfile demoted to dev-dependency)
- Removed the sync.status IPC method from breadd plus its integration tests
- Moved the generic `expand_path` helper into bread-shared (with unit tests)

CI now actually runs and gates quality:
- Trigger on master/dev (was `main` — CI had never run, not once)
- Added `cargo fmt --check` and `clippy -D warnings`; fixed 4 clippy warnings
- Dropped the macOS matrix entry (breadd is Linux-only: udev/rtnetlink);
  added the libudev-dev system dependency the Linux build needs

Hardening / honesty:
- New ipc test: daemon survives repeated reloads and the event pipeline
  resumes (the prior suite only had a single happy-path reload check)
- Docs scrubbed of sync across README/Documentation/Overview/DAEMON
- "production-ready" and "compositor-agnostic" claims reworded to match
  reality rather than aspiration

Note: bread-sync/src/export.rs held pre-existing local WIP authored outside
this change set and is intentionally excluded from this commit.
2026-05-17 00:22:21 +08:00

1.7 KiB
Raw Blame History

bread-sync — slated for extraction

This crate is no longer part of the bread workspace. It is parked here pending extraction into its own standalone project.

Why

bread's architecture deliberately scopes itself to a reactive automation fabric — see the Non-Goals in Overview.md. State/dotfile synchronization across machines is explicitly out of that scope. bread-sync grew into a git-backed snapshot/restore + package + delegate-path manager, which is a genuinely useful tool but a different product with a different lifecycle. It was the one component pulling bread's scope discipline out of shape, so it is being spun out rather than removed (the code is good; it just doesn't belong in this repo).

Status

  • Removed from the root Cargo.toml workspace (members → exclude).
  • The bread sync … CLI subcommands have been removed from bread-cli.
  • The sync.status IPC method and its integration tests have been removed from breadd.
  • No code in bread/breadd/bread-cli depends on this crate anymore.

For whoever extracts it (name polls are open)

  1. Move this directory into the new repository.
  2. It inherited workspace dependencies (serde, git2, dirs, chrono, tempfile, glob, …). Pin concrete versions in its own Cargo.toml; *.workspace = true will not resolve outside this workspace.
  3. The only helper that had to leave this crate is config::expand_path, which moved to bread-shared::expand_path because non-sync code (the module installer) needed it. Reintroduce a local copy in the new project so it no longer depends on bread-shared.
  4. Re-add the bread sync UX as a standalone binary, or as a breadd IPC client, in the new project — not here.