Document Narratio v3.0.0 migration and release
This commit is contained in:
57
docs/releases/v3.0.0.md
Normal file
57
docs/releases/v3.0.0.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Narratio v3.0.0
|
||||
|
||||
This major release moves Narratio pipeline selection to ConfigKit overlays and
|
||||
updates its Audita and Notarius integration contracts. Existing deployments
|
||||
must migrate configuration before running affected sessions.
|
||||
|
||||
## Compatibility and upgrade
|
||||
|
||||
- Replace Narratio's `--profile <name>` with `--overlay <name>` and move selected
|
||||
`profiles/<name>.yml` files to `overlays/<name>.yml` beside the pipeline root.
|
||||
The old flag and selected directory are no longer supported; explicit imports
|
||||
from a directory named `profiles` remain valid. Update `config diff` positional
|
||||
selections accordingly. See [configuration](../config.md#pipeline-imports-and-overlays)
|
||||
and the [CLI reference](../cli.md).
|
||||
- Before opening a session manifest containing
|
||||
`effective_config.selected_profile`, back it up and follow the
|
||||
[manifest migration procedure](../operations.md#migrating-manifest-overlay-provenance).
|
||||
Strict decoding rejects the retired field. Preserve the manifest's stage and
|
||||
checkpoint state; this informational rename does not itself require rerunning
|
||||
every stage. Immutable remote snapshots are not edited in place.
|
||||
- Deploy an Audita v2 executable and migrate its configuration before running
|
||||
`polish`. Narratio no longer generates an Audita config or accepts the old
|
||||
endpoint, model, concurrency, singular API-key, report, and retention fields.
|
||||
Audita now owns backends, PromptKit profiles, reporting, and debug settings;
|
||||
Narratio accepts optional downstream selectors and forwards only names listed
|
||||
in `pipeline.audita.credentials`. Follow the
|
||||
[Audita migration table](../operations.md#migrating-audita-and-provider-credentials)
|
||||
and [integration contract](../integrations/audita.md).
|
||||
- Replace `pipeline.notarius.llm_api_key` with the
|
||||
`pipeline.notarius.credentials` list. Rename
|
||||
`pipeline.notarius.config_profile` to `config_overlay` and move selected
|
||||
downstream Notarius files to its `overlays/` directory. The old fields have
|
||||
no compatibility aliases. A named downstream overlay requires a compatible
|
||||
Notarius executable; v0.8.1 is the tested baseline, while deployments that
|
||||
omit the selector gain no new version requirement. See the
|
||||
[Notarius configuration reference](../config.md#notarius-configuration-overlay)
|
||||
and [integration contract](../integrations/notarius.md).
|
||||
|
||||
## Changes
|
||||
|
||||
- Narratio and downstream overlay names are independent. Operators can select
|
||||
separate Audita and Notarius overlays from one Narratio overlay without
|
||||
implicit name forwarding. ConfigKit is updated to v0.4.2.
|
||||
- Audita's corrected transcript remains the canonical polish output. Available
|
||||
`errors.yml`, `recoveries.yml`, and `report.md` files are retained as bounded
|
||||
diagnostics; missing reports are allowed, and an exit-zero valid transcript
|
||||
succeeds even when reports describe recoverable errors or no corrections.
|
||||
- Audita and Notarius credential lists resolve at pipeline load and forward
|
||||
captured values under their exact names, with captured subprocess output and
|
||||
failure diagnostics redacted. Narratio does not discover backend credentials
|
||||
from downstream configuration; operators must list the names those tools need.
|
||||
- Repository policy, license/attribution notices, release validation, and the
|
||||
asynchronous artifact-delivery procedure are aligned with the current
|
||||
[release runbook](../release.md). Completed implementation roadmaps have been
|
||||
retired from the candidate source.
|
||||
|
||||
[COPYRIGHT](https://gitea.maximumdirect.net/eric/narratio/src/tag/v3.0.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/narratio/src/tag/v3.0.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/narratio/src/tag/v3.0.0/docs/oss/attribution.md)
|
||||
Reference in New Issue
Block a user