feat(platformctl): implement lint --cross-refs to catch INDEX/ADR/runbook integrity drift automatically #767

Closed
opened 2026-06-08 23:19:51 +02:00 by ollama · 0 comments
Collaborator

Spec sources (whitelist)

  • modules/INDEX.yaml — cross-reference against module manifests
  • modules/*/module.yaml — all 88 module manifests
  • modules/*/runbook.md — existence check vs module manifest
  • decisions/ — all ADR files
  • MAP.md — references to ADRs
  • AGENTS.md — references to ADRs
  • README.md — references to ADRs
  • state/ — references to ADRs
  • control-plane/platformctl/cli.py — where to add subcommand
  • schema/module.schema.json — module structure

Extracted context

Multiple cross-reference integrity issues have been found in audits:

  • INDEX.yaml lifecycle drifted from module manifests (#752)
  • Duplicate ADR-0023 (#756)
  • Phantom ADR references in MAP.md (fixed in #748)
  • Runbooks with no parent module (potential)

A lint command would catch these early, before they become issues.

Scope

Implement platformctl lint --cross-refs that checks:

  1. INDEX.yaml vs modules: every module in INDEX.yaml has a matching module.yaml, and every module.yaml has an INDEX.yaml entry. Lifecycle, criticality, area, host match.
  2. ADR numbering: no duplicate numbers, no gaps in sequence (warning), all referenced ADRs exist.
  3. ADR references: all ADR-00XX references in repo docs point to existing files.
  4. Runbook coverage: every module.yaml has a runbook.md, every runbook.md has a parent module.yaml.

Exit codes: 0=all clean, 3=validation errors, 0 with warnings=advisory findings.

Acceptance criteria

  • platformctl lint --cross-refs catches all 4 check types
  • Detects the known issues: INDEX.yaml drift, duplicate ADR, orphan runbooks
  • JSON output for CI integration
  • 715+ existing tests still green
  • CI workflow note: add cross-ref lint as prebuild check

Do NOT read

  • Full repo — only files needed for implementation

Agent notes

  • Recommended executor: Gemini 3.1 Pro (new platformctl command)
  • Size: Medium (~200 lines)
  • Review tier: tier/medium (new CI-enforceable command)
  • Audit ref: state/audit/deepseek-2026-06-08-multiperspective.md §Improvement #5
## Spec sources (whitelist) - `modules/INDEX.yaml` — cross-reference against module manifests - `modules/*/module.yaml` — all 88 module manifests - `modules/*/runbook.md` — existence check vs module manifest - `decisions/` — all ADR files - `MAP.md` — references to ADRs - `AGENTS.md` — references to ADRs - `README.md` — references to ADRs - `state/` — references to ADRs - `control-plane/platformctl/cli.py` — where to add subcommand - `schema/module.schema.json` — module structure ## Extracted context Multiple cross-reference integrity issues have been found in audits: - INDEX.yaml lifecycle drifted from module manifests (#752) - Duplicate ADR-0023 (#756) - Phantom ADR references in MAP.md (fixed in #748) - Runbooks with no parent module (potential) A lint command would catch these early, before they become issues. ## Scope Implement `platformctl lint --cross-refs` that checks: 1. **INDEX.yaml vs modules**: every module in INDEX.yaml has a matching module.yaml, and every module.yaml has an INDEX.yaml entry. Lifecycle, criticality, area, host match. 2. **ADR numbering**: no duplicate numbers, no gaps in sequence (warning), all referenced ADRs exist. 3. **ADR references**: all `ADR-00XX` references in repo docs point to existing files. 4. **Runbook coverage**: every module.yaml has a runbook.md, every runbook.md has a parent module.yaml. Exit codes: 0=all clean, 3=validation errors, 0 with warnings=advisory findings. ## Acceptance criteria - [ ] `platformctl lint --cross-refs` catches all 4 check types - [ ] Detects the known issues: INDEX.yaml drift, duplicate ADR, orphan runbooks - [ ] JSON output for CI integration - [ ] 715+ existing tests still green - [ ] CI workflow note: add cross-ref lint as prebuild check ## Do NOT read - Full repo — only files needed for implementation ## Agent notes - Recommended executor: Gemini 3.1 Pro (new platformctl command) - Size: Medium (~200 lines) - Review tier: tier/medium (new CI-enforceable command) - Audit ref: state/audit/deepseek-2026-06-08-multiperspective.md §Improvement #5
Sign in to join this conversation.
No labels
W6d-automerge-calibration
agent/claude-code
agent/codex
agent/hermes
agent/iskra
agent/ollama
agent/patchwarden
automerge-candidate
class/security-sensitive
cutover-gate
dependency/blocked
dependency/blocks-others
dependency/cross-repo
dependency/needs-confirmation
domain:agents
domain:ci
domain:docs
domain:forgejo
domain:infra
domain:memory
domain:runtime
domain:signal
domain:ux
flow/architecture
flow/blocked
flow/deployed
flow/done
flow/implementation
flow/intake
flow/maintained
flow/observed
flow/ready
flow/refining
flow/retired
flow/review
iterating
judge/codex-candidate
judge/hermes-candidate
judge/low-confidence
judge/needs-refinement
judge/operator-needed
judge/p0
judge/p1
judge/p2
judge/p3
judge/park
judge/patchwarden-candidate
judge/stale-priority
kind/adr
kind/bug
kind/chore
kind/feature
kind/infra
kind/ops
kind/refactor
kind/research
large-impact
merge/auto
merge/manual
merge/manual-dependency-conflict
merge/manual-failing-tests
merge/manual-merge-conflict
merge/manual-missing-review
merge/manual-operator-preference
merge/manual-red-zone
merge/manual-security-sensitive
merge/manual-unclear-scope
merge/manual-unknown
meta
mode:operator-only
mode:patchwarden-iskra-approved
mode:safe-auto
needs-operator-decision
needs-triage
not-ready
observed/erroring
observed/needs-followup
observed/pending
observed/retire-candidate
observed/unused
observed/used
operator-emotional
owner-attention
phase/02
phase/03
priority:p0
priority:p1
priority:p2
priority:p3
proposed
ready-for-agent
ready-for-operator
recovery
review:claude-reviewed
review:codex-reviewed
review:dziadek-reviewed
review:needs-human
risk/exposure
risk/process
risk/product
risk/runtime
safety:external-write
safety:no-prod-mutation
safety:prod-impact
safety:secret-touch
size/large
size/medium
size/small
size/tiny
size/unknown
source/adr
source/agent-generated
source/manual
source/operator-chat
source/voice-note
status:blocked
status:codex-ready
status:merged:pending-evidence
status:needs-evidence
status:operator-needed
status:parked
tier/full
tier/lite
tier/stacked
tier:0-platform-substrate
tier:1-iskra-value-layer
tier:2-tools-products-modules
type:bug
type:chore
type:docs
type:feat
type:policy
type:research
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
pdurlej/platform#767
No description provided.