Files
reuse-surface/registry/capabilities/capability.registry.register.md
tegwick 270065ff58
Some checks failed
ci / validate-registry (push) Has been cancelled
Implement REUSE-WP-0012 federation scale and intent alignment
Add hub sync and report cohorts CLI commands with pytest coverage, document
sibling index publish contract and hub hardening path, align INTENT layout,
raise external evidence on three registry entries, and close gap priorities
19-23 (priority 18 deferred on sibling index blocks).
2026-06-16 00:42:50 +02:00

6.3 KiB

id, name, summary, owner, status, domain, tags, maturity, external_evidence, discovery, availability, relations, evidence, consumer_guidance, promotion_history
id name summary owner status domain tags maturity external_evidence discovery availability relations evidence consumer_guidance promotion_history
capability.registry.register Capability Registration Register a new capability so it becomes visible for planning and implementation reuse. reuse-surface draft helix_forge
registry
governance
meta
discovery availability
current target confidence rationale
D3 D5 medium Core use case UC-RS-001 is documented in specs/UseCaseCatalog.md and the registry model is bounded in INTENT.md, but concrete promotion workflows are not yet grounded in registry artifacts.
current target confidence rationale
A4 A5 medium Local registry workflows use the reuse-surface CLI (A3). Federation repo registration is also available through the hosted hub HTTP API at reuse.coulomb.social (POST/PATCH /v1/repos), deployed and dogfood-tested on Railiance01 (REUSE-WP-0011).
completeness reliability
level name confidence basis satisfied_expectations broken_expectations out_of_scope_expectations
C2 Partial medium scope_vs_intent_and_consumer_expectations
capability IDs can be assigned in registry entries
maturity vectors can be recorded at registration time
CLI validate, query, and export support registry workflows
promotion history can be recorded in entries
federation repo registration via hosted hub API and hub CLI
no automated duplicate detection yet
hosting registered capabilities
enforcing implementation architecture
level name confidence basis known_reliability_risks evidence
R3 Usable medium consumer_quality_signals
index drift still possible if authors skip validate
CLI requires local venv install
sibling repos cannot register until indexes publish raw URLs
satisfied_signals
CI validate with fail-on-warnings on every push
hub register/list/federated smoke on production reuse.coulomb.social
pytest coverage for hub API and federation compose paths
intent includes excludes assumptions use_cases research_memos
Make a capability candidate visible in the registry so humans and agents can discover, assess, compare, and reuse it instead of rebuilding it in isolation.
stable capability ID assignment
initial discovery and availability classification
explicit completeness and reliability placeholders
evidence and relation references
implementing the registered capability
certifying implementation quality
operating runtime services for registered capabilities
unregistered capabilities are invisible for registry-driven reuse
low-maturity entries are acceptable when evidence gaps are explicit
UC-RS-001
specs/UseCaseCatalog.md
specs/ProductRequirementsDocument.md
current_level target_level current_artifacts target_artifacts consumption_modes
A4 A5
templates/capability-entry.template.md
registry/indexes/capabilities.yaml
reuse_surface/cli.py
reuse_surface/hub/
specs/FederationHubAPI.md
https://reuse.coulomb.social
packaged container release with documented SLO
informational
markdown authoring
cli
service API
depends_on supports related_to
capability.feature-control.evaluate
capability.identity.vocabulary-canonicalize
capability.registry.validate
documentation tests consumer_feedback bug_reports incidents
INTENT.md
specs/UseCaseCatalog.md
specs/FederationHubAPI.md
docs/deploy/reuse-kubernetes.md
tests/test_hub.py
tests/test_hub_sync.py
.gitea/workflows/ci.yml
reuse-surface dogfood (REUSE-WP-0011): production hub registration and /v1/federated compose succeeded on Railiance01 without write-path regressions after WP-0011 deploy.
recommended_for not_recommended_for known_limitations
making a new capability visible at D0/A0/C0/R0 with minimal friction
seeding planning discussions before implementation exists
treating registry presence as proof of implementation readiness
skipping explicit evidence for maturity promotion
manual index updates are required after adding an entry
duplicate detection is guidance-only in the MVP
date dimension from to rationale author
2026-06-14 discovery D0 D1 Added name, summary, and registry-first intent from INTENT.md. reuse-surface
date dimension from to rationale author
2026-06-15 discovery D1 D3 Bounded scope with UC-RS-001 and MVP registry artifacts in specs/. reuse-surface
date dimension from to rationale author
2026-06-15 availability A0 A3 reuse-surface CLI shipped validate, query, and export commands. reuse-surface
date dimension from to rationale author
2026-06-15 availability A3 A4 Hosted federation hub live at reuse.coulomb.social; hub register/update via HTTP API and reuse-surface hub CLI; production deploy on Railiance01. reuse-surface
date dimension from to rationale author
2026-06-16 reliability R2 R3 CI gates, pytest hub/federation coverage, and production hub smoke support normal registration workflows with documented limitations. reuse-surface

Capability Registration

Overview

Registration is the entry point for reuse visibility. A capability that is not registered cannot be discovered through the registry surface, even if code or documentation exists elsewhere.

Current reuse mode

Local registry (A3 CLI): add Markdown entries under registry/capabilities/, update registry/indexes/capabilities.yaml, run reuse-surface validate.

Federation registration (A4 API): register published index URLs on the hosted hub (reuse-surface hub register, POST /v1/repos) for cross-repo discovery via GET /v1/federated.

Next promotion steps

  1. Attach concrete use cases and actors to reach D5.
  2. Package hub as a versioned container release with operator SLO (A5).
  3. Record consumer expectations and broken expectations as external evidence.