generated from coulomb/repo-seed
tegwick
3b909338cb
Some checks failed
validate-registry / validate (push) Has been cancelled
Activate WP-0003 and WP-0004. Add tools/effective_config.py (deterministic, order-independent override-path resolver — path only, never a value) and tools/config_explain.py + `make explain` to render the layer path, winning layer, validator, owner, consumers, and secret references for any surface.*. Verified on all 4 seeded surfaces; order-independent; no values/secrets leak. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
## Stack
|
|
|
|
- **Language:** Markdown-first registry and planning repo (no application runtime)
|
|
- **Key deps:** State Hub ADR-001 workplans, `registry/indexes/{capabilities,surfaces}.yaml`,
|
|
`schemas/surface-entry.schema.json` (validated with PyYAML + jsonschema)
|
|
|
|
## Dev Commands
|
|
|
|
```bash
|
|
# Orient (offline-safe)
|
|
cat .custodian-brief.md
|
|
cat INTENT.md
|
|
cat SCOPE.md
|
|
ls workplans/
|
|
ls registry/
|
|
|
|
# Validate the registry (the CI gate — run after any registry/schema edit)
|
|
make validate # schema + index + whitespace + reuse-surface
|
|
python3 tools/validate_registry.py # schema + index consistency only
|
|
git diff --check # whitespace / conflict markers
|
|
reuse-surface validate --root . # capability federation (from reuse-surface checkout)
|
|
|
|
# Explain a surface's effective-config override path (no values shown)
|
|
make explain SURFACE=surface.infotech.state-hub.api-config
|
|
|
|
# After workplan or registry edits — from ~/state-hub
|
|
make fix-consistency REPO=config-atlas
|
|
```
|
|
|
|
**Validation gate (CI):** `make validate` is the single gate run by agents and CI
|
|
(`.github/workflows/validate.yml`, read by GitHub *and* Gitea Actions). It validates
|
|
every `registry/surfaces/*.md` against `schemas/surface-entry.schema.json`
|
|
(forbidding inline values/secrets), checks `registry/indexes/surfaces.yaml`
|
|
consistency, and runs `git diff --check`. Requires `pip install pyyaml jsonschema`.
|
|
|
|
**Install / test / build / run:** not applicable — no application runtime. Verify
|
|
changes with `make validate`. |