Luigit
repositories / smith

smith

There are many coding harnesses - but this one is fast

owned by admin

.system/plans/SMH-PLAN-RELS0001-docs-release-and-hardening/index.md

Raw
Rendered preview

id: SMH-PLAN-RELS0001 type: plan title: "Release Readiness" spec: SMH-SPEC-SPEC0001 status: draft depends_on: [SMH-PLAN-TUIR0001]

Release Readiness

Entry

  • Fullscreen interactive, eval, RPC, replay, provider, tool, and plugin paths work end to end.
  • Public SDK boundaries are stable enough to document.

Order

  1. Complete provider catalog ingestion, provenance, conflict reporting, cached fallback, and human review flow.
  2. Generate plugin SDK help from the authoritative contract declarations and usage descriptions.
  3. Verify public Rust, plugin, event, command, and configuration documentation for completeness and drift.
  4. Complete architecture, lint, format, test, documentation, audit, coverage, mutation, and benchmark gates through Cargo automation.
  5. Add cargo-semver-checks to the gate set: public API breaks fail before release.
  6. Add cargo-auditable to release builds: dependency manifests embedded in binaries.
  7. Harden provider streams, compaction, session recovery, plugin rollback, project trust, terminal restoration, RPC framing, and tool cancellation against recorded edge cases.
  8. Build versioned release archives and SHA-256 checksums for required targets with cargo-zigbuild or cross for foreign targets; cargo-dist or cargo-release may drive packaging only where it does not own automation.
  9. Extend the mold linker table to every released Linux target.
  10. Verify supported target startup, fullscreen restoration, eval, RPC, and replay behavior from release artifacts.

Interfaces

  • xtask provider workflow: suggestions, provenance, conflicts, and reviewed publication.
  • xtask documentation workflow: extraction, completeness, examples, and drift checks.
  • xtask quality workflow: required repository gates.
  • xtask release workflow: target artifacts and checksums.

Verification

  • Generated provider suggestions never overwrite authoritative values automatically.
  • Runtime catalog refresh remains usable offline and cannot publish stale state.
  • Generated help and exposed SDK agree.
  • Required gates run without secrets or live provider access.
  • Release archives contain the expected binary and verify against published checksums.
  • Supported artifacts restore terminal state and execute provider-free replay.
  • Regression coverage includes every failure class recorded by earlier plans.

Exit

A documented, reproducible Smith release passes all required gates and operates without maintainer-only knowledge.

Stop conditions

  • A required gate depends on live credentials or uncontrolled network state.
  • Documentation creates a second SDK source of truth.
  • A release target cannot satisfy terminal restoration or session safety requirements.
---
id: SMH-PLAN-RELS0001
type: plan
title: "Release Readiness"
spec: SMH-SPEC-SPEC0001
status: draft
depends_on: [SMH-PLAN-TUIR0001]
---

# Release Readiness

## Entry

- Fullscreen interactive, eval, RPC, replay, provider, tool, and plugin paths work end to end.
- Public SDK boundaries are stable enough to document.

## Order

1. Complete provider catalog ingestion, provenance, conflict reporting, cached fallback, and human review flow.
2. Generate plugin SDK help from the authoritative contract declarations and usage descriptions.
3. Verify public Rust, plugin, event, command, and configuration documentation for completeness and drift.
4. Complete architecture, lint, format, test, documentation, audit, coverage, mutation, and benchmark gates through Cargo automation.
5. Add `cargo-semver-checks` to the gate set: public API breaks fail before release.
6. Add `cargo-auditable` to release builds: dependency manifests embedded in binaries.
7. Harden provider streams, compaction, session recovery, plugin rollback, project trust, terminal restoration, RPC framing, and tool cancellation against recorded edge cases.
8. Build versioned release archives and SHA-256 checksums for required targets with `cargo-zigbuild` or `cross` for foreign targets; `cargo-dist` or `cargo-release` may drive packaging only where it does not own automation.
9. Extend the mold linker table to every released Linux target.
10. Verify supported target startup, fullscreen restoration, eval, RPC, and replay behavior from release artifacts.

## Interfaces

- `xtask` provider workflow: suggestions, provenance, conflicts, and reviewed publication.
- `xtask` documentation workflow: extraction, completeness, examples, and drift checks.
- `xtask` quality workflow: required repository gates.
- `xtask` release workflow: target artifacts and checksums.

## Verification

- Generated provider suggestions never overwrite authoritative values automatically.
- Runtime catalog refresh remains usable offline and cannot publish stale state.
- Generated help and exposed SDK agree.
- Required gates run without secrets or live provider access.
- Release archives contain the expected binary and verify against published checksums.
- Supported artifacts restore terminal state and execute provider-free replay.
- Regression coverage includes every failure class recorded by earlier plans.

## Exit

A documented, reproducible Smith release passes all required gates and operates without maintainer-only knowledge.

## Stop conditions

- A required gate depends on live credentials or uncontrolled network state.
- Documentation creates a second SDK source of truth.
- A release target cannot satisfy terminal restoration or session safety requirements.