mirror of
https://github.com/openclaw/openclaw.git
synced 2026-08-11 01:30:08 +00:00
367ff3cea1
* feat(sqlite): migrate persisted media to canonical facts and stop legacy writes PR 3 of the media legacy retirement program — the operator-approved canonical cutover. - openclaw doctor --fix owns one idempotent migration: active transcript_events rows canonicalize to __openclaw.media (facts-first gap-fill, bare legacy kinds to fact.kind, transcribed indexes and workspace dirs onto per-fact fields) via the transcript replacement owner; cold plain/.zst archives rewrite through temp-file + codec readback + event/id verification + atomic replace; trajectory runtime snapshots canonicalize IN PLACE (telemetry preserved, never row deletion). Invalid JSON, genuinely ambiguous legacy-only sparse alignment, or a changed source aborts that owner without partial work; reruns are no-ops. - Per-agent schema advances to v16 as a pure downgrade guard (main independently took v15 for board/session-sharing tables; no columns/tables/indexes change here, shared-state DB untouched). v15 databases repair canonical indexes before the version assertion so repairable installations never strand. - The user-turn builder stops writing top-level legacy Media* fields; shouldPersistStructuredMediaEntries and the aligned projection mode are deleted; the generic transcript append boundary canonicalizes every message role so SDK/mirror writers cannot mint new legacy rows. - Internal persisted-reader legacy fallbacks are removed; the public SDK projection stays until retirement PR 4's window expires. Hardening from three adversarial review rounds, each with fixture regressions: in-place trajectory canonicalization instead of row deletion; repair-before-assert on the v15 path; all-roles append canonicalization; duplicate-preserving exact row rewrites; v0-v15 reopen guards; complete canonical facts bypass compact legacy projections (PR-1 dual-write rows migrate cleanly); SQLite LIKE underscore escaped so populated foreign databases are never claimed. * fix(sqlite): align schema-support metadata and gates with the v16 cutover package.json agent schema support advances to 16; verifier and board parity fixtures run doctor migration before steady-state access (the production guards were correct); two test-only exports removed; the migration module registered in the doctor raw-SQLite allowlist.
summary, read_when, title
| summary | read_when | title | |||
|---|---|---|---|---|---|
| Repository script entry points and compatibility notes |
|
Scripts Directory |
Scripts Directory
The scripts/ directory contains repository tooling used by local development,
CI, docs publishing, releases, Docker proof, and maintainer operations. Prefer
the package-script entry points in package.json when one exists, then read the
underlying script before running it directly.
Compatibility
Many scripts are stable paths referenced by package.json, GitHub Actions,
docs, and maintainer runbooks. Do not move, rename, or regroup scripts only to
improve taxonomy. A directory migration needs an explicit maintainer-approved
compatibility plan for package scripts, workflows, docs snippets, and any raw
script paths users may have copied.
This index is a discovery aid for the current flat layout. It does not define a new directory taxonomy.
Common Entry Points
| Area | Prefer | Notes |
|---|---|---|
| Build | pnpm build |
Runs scripts/build-all.mjs; use specific build scripts only when debugging a build stage. |
| Changed checks | pnpm changed:lanes --json, pnpm check:changed |
Lane classification lives in scripts/changed-lanes.mjs; changed-file checks live in scripts/check-changed.mjs. |
| Docs | pnpm docs:list, pnpm docs:check-mdx, pnpm docs:check-links |
Backed by scripts/docs-list.js, scripts/check-docs-mdx.mjs, and scripts/docs-link-audit.mjs. |
| Formatting docs | pnpm format:docs:check |
Uses scripts/format-docs.mjs; use write mode only when intentionally formatting docs. |
| Lint | pnpm lint, pnpm lint:core, pnpm lint:all |
Wrapper scripts keep oxlint behavior aligned with repo config. |
| Targeted tests | pnpm test <path-or-filter> or node scripts/run-vitest.mjs <path-or-filter> |
Avoid bare vitest; it can start watch mode. |
| Changed tests | pnpm test:changed |
Uses the repo's changed-test resolver instead of a broad Vitest run. |
| Docker proof | pnpm test:docker:all, pnpm test:docker:rerun, pnpm test:docker:timings |
Use the planner/rerun helpers before launching broad Docker work. |
| Live proof | pnpm test:live |
Live checks require the matching environment and credentials. |
| Release checks | pnpm release:check, pnpm release:beta, pnpm release:candidate |
Release scripts are maintainer workflows; read release docs before use. |
| GitHub reads | scripts/gh-read |
Uses a GitHub App read token when configured, leaving normal gh login for writes. |
| Commits | scripts/committer "<message>" <files...> |
Preferred scoped commit helper for OpenClaw changes. |
| Remote proof | node scripts/crabbox-wrapper.mjs ... |
Agent default for tests and heavy work; pre-warm by source trust, sync each run, reuse the lease. |
Script Families
check-*.mjs/check-*.ts: guardrails for architecture, docs, package contents, boundaries, workflows, and generated artifacts.run-*.mjs: wrappers around repo runtimes or tools, such as Node, Vitest, oxlint, tsgo, and environment setup.test-*.mjs/test-*.sh/test-*.ts: test planners, Docker lanes, live checks, and focused validation helpers.docs-*andcheck-docs-*: docs listing, link auditing, MDX checks, spellcheck, sync, and i18n glossary checks.release-*,openclaw-npm-*, andplugin-*-release-*: release preparation, package verification, and publishing helpers.docker-*,test-docker-*, andtest-live-*-docker.sh: Docker E2E planning, rerun, timing, and live/package lane helpers.gh-read*,label-*,sync-labels.ts, and PR helpers: GitHub read, labeling, and maintainer workflow support.generate-*,write-*,copy-*, andsync-*: generated docs, metadata, package surfaces, and build artifact support.lib/: shared helpers imported by script entry points.
Maintenance Rules
- Read
scripts/AGENTS.mdbefore changing scripts. - Keep package scripts, generators, generated-artifact checks, docs references, and workflow references aligned when touching a script path.
- Prefer existing wrappers instead of introducing a raw tool invocation.
- Add or update focused tests under
test/scripts/when changing script behavior.
See also Scripts for public-facing script guidance.