Prototype ConfigKit and PromptKit adoption and record the findings
This commit is contained in:
43
examples/library-adoption/README.md
Normal file
43
examples/library-adoption/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Offline Library Adoption Prototype
|
||||
|
||||
This experimental executable exercises Audita's ConfigKit/PromptKit boundary. It
|
||||
is a standalone nested Go module, not a production Audita command. Its configuration
|
||||
and profile files are accepted by this prototype only. Design decisions, limitations,
|
||||
and migration status belong to the [findings](../../docs/roadmap/library-boundary-findings.md).
|
||||
|
||||
From this directory, acquire dependencies once (network access required):
|
||||
|
||||
```sh
|
||||
GOWORK=off go mod download all
|
||||
```
|
||||
|
||||
Use Go 1.25.5 or newer. With dependencies and the chosen toolchain already installed,
|
||||
these commands run offline and require no credentials:
|
||||
|
||||
```sh
|
||||
GOTOOLCHAIN=local GOWORK=off GOPROXY=off GOSUMDB=off go run .
|
||||
GOTOOLCHAIN=local GOWORK=off GOPROXY=off GOSUMDB=off go test ./...
|
||||
GOTOOLCHAIN=local GOWORK=off GOPROXY=off GOSUMDB=off go test -race ./...
|
||||
```
|
||||
|
||||
The demonstration supplies a synthetic key in its own process. Its HTTP transport
|
||||
never makes a network connection. Both proposal and assessment first return invalid
|
||||
JSON, then valid output. Expected output reports one accepted correction, four
|
||||
attempts, zero transient retries, and two structural repairs. It previews a synthetic
|
||||
transcript correction without writing transcript files.
|
||||
|
||||
Tests control provider responses, capacity, and cancellation. They cover positive
|
||||
repair budgets for both roles, exhausted repair, domain rejection, transient retry,
|
||||
combined budgets, partial usage, credential redaction, and finite shared capacity.
|
||||
Tests do not contact a provider or read real credentials.
|
||||
|
||||
Root `go test ./...` does **not** cover this nested module. No `go.work`, local
|
||||
replacement, or sibling library checkout is required. Published Audita v1.1.0 supplies
|
||||
its internal domain helpers; the module namespace intentionally permits those
|
||||
imports. The prompts are adapted from that release's grammar proposal and grammar
|
||||
review assets, with the shared hardening fragment expanded. A parity test compares
|
||||
rendered messages. The schema fixtures are the corresponding Audita response schemas.
|
||||
|
||||
This is temporary integration evidence. Production migration will move the proven
|
||||
adapter decisions into Audita and replace this directory with appropriate integration
|
||||
tests; it will not ship a second supported runtime.
|
||||
Reference in New Issue
Block a user