forked from jason/echo
jason
65 lines
3.5 KiB
Markdown
65 lines
3.5 KiB
Markdown
# echo-memory — Maintenance & repo hygiene (M5)
|
||
|
||
Low-lift cleanups that remove "which copy is canonical?" traps before tagging 1.0.
|
||
None of these change runtime behavior; they reduce drift and confusion.
|
||
|
||
## Canonical source tree
|
||
|
||
- **`echo-memory.plugin.src/`** is the single canonical source tree. ✅
|
||
- **`codex plugin/`** has already drifted — it lacks the 0.9 modules
|
||
(`echo_index.py`, `echo_links.py`, `echo_ops.py`, `sweep.py`, `check_routing.py`).
|
||
- [ ] Decide: regenerate it from the canonical tree as a build target, **or** delete it
|
||
and document the codex/CoWork packaging step instead.
|
||
- [ ] Until resolved, add a `codex plugin/README.md` note: "derived — do not edit by hand."
|
||
|
||
## Build artifacts
|
||
|
||
The repo root carries every historical build (`echo-memory-0.6.0.plugin` …
|
||
`echo-memory-0.9.0.plugin`) plus `echo-memory.plugin`.
|
||
- [ ] Keep only the latest `echo-memory.plugin` (the installable) tracked; move versioned
|
||
zips to GitHub Releases (or a `dist/` that is git-ignored).
|
||
- [ ] Add `*.plugin` build outputs to `.gitignore` except the current pointer, if desired.
|
||
- [x] `.gitignore` added (`.DS_Store`, `__pycache__`, local `.echo-memory/`, eval output).
|
||
|
||
## `plugin.json` completeness
|
||
|
||
- [x] Add `license` (UNLICENSED — personal, not for distribution).
|
||
- [x] Version bumped to **1.0.0**.
|
||
- [ ] Add `homepage` / repository URL (optional — repo URL not yet decided).
|
||
- [ ] (Optional) register slash commands in the manifest; they're auto-discovered from
|
||
`commands/` today (`echo-load|save|recall|triage|health|sweep|reflect|doctor`).
|
||
|
||
## Docs freshness
|
||
|
||
- [ ] `eval/run_eval.py` still benchmarks **0.6 vs 0.7** — refresh to current (open H4 follow-up).
|
||
- [x] README version-history has a **1.0.0** entry; title bumped to v1.0.0.
|
||
- [x] Scrub the literal bearer token from docs → `$ECHO_KEY` placeholder (M1, done:
|
||
`api-reference.md` ×11, `SKILL.md`, `bootstrap.md`, eval harness). Operator key setup
|
||
documented in `API-KEY-SETUP.md`. Last remaining copy is `echo.py` `DEFAULT_KEY`
|
||
(deprecated fallback) — **remove once `ECHO_KEY` is set in every environment**.
|
||
|
||
## Building the `.plugin` artifact
|
||
|
||
`python build.py` zips `echo-memory.plugin.src/` into `echo-memory-<version>.plugin` (version
|
||
read from the manifest) and refreshes the `echo-memory.plugin` pointer. Deterministic
|
||
(sorted entries + fixed timestamp → byte-identical rebuilds). Flags:
|
||
|
||
- `--strip-key` — blank `echo.py` `DEFAULT_KEY` so **no token ships** (runtime then needs
|
||
`ECHO_KEY` or `~/.echo-memory/credentials`). Use this once the key is set everywhere.
|
||
- `--no-pointer` — skip refreshing `echo-memory.plugin`.
|
||
- `--outdir DIR` — write artifacts elsewhere.
|
||
|
||
Without `--strip-key` the build warns that the baked-in token is present.
|
||
|
||
## Pre-1.0 release checklist
|
||
|
||
- [x] All 10 roadmap items wired; scaffold TODOs cleared (see `ROADMAP-1.0.md` status table).
|
||
- [x] `schema_version` bumped to 4 (sweep/migrate); `migrate.py` `[3→4]` step added.
|
||
*Verify on a copy of the live vault before migrating it (it currently reports schema 3).*
|
||
- [x] Offline suites green in CI on Win/macOS/Linux × Py 3.10/3.12 (check_routing,
|
||
test_echo_client, test_v1_scaffold, test_features, test_patch_semantics,
|
||
test_offline_queue, test_reflect).
|
||
- [ ] No live secret in the tracked tree or the built `.plugin` — **one line left**: delete
|
||
`echo.py` `DEFAULT_KEY` after `ECHO_KEY`/credentials are set everywhere (per `API-KEY-SETUP.md`).
|
||
- [ ] `eval/run_eval.py` reports current-version retrieval/durability metrics (open follow-up).
|