eric/audita
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

Clarify migration and subprocess failure guidance

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-10 20:27:26 +00:00
parent 9a52c8c246
commit 56d39fca80
4 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/migrations/v3.md
View File

@@ -1,21 +1,25 @@
# Migrating to application configuration v3
Audita v3 is a hard cutover. Move application settings to `version: 3` and use
[the configuration reference](../config.md) and [maintained examples](../../examples/)
to construct the new files. The previous configuration and standalone glossary
formats are not loaded by the new processing path.
Audita 3.1.x uses application configuration schema v2. For the cutover to schema
v3, set `version: 3` in the application file and move glossary entries into
configuration. Use the [configuration reference](../config.md) and
[maintained examples](../../examples/) for the new formats.
- Replace `pipeline.modules` with ordered `pipeline.stages` records containing
`module` and any per-entry overrides. An explicit empty list runs normalization.
- Define named `glossary_collections` in configuration or its companion imports;
select them using `glossaries` and `protected_terms`. Remove `--glossary` and
`--modules` from invocations.
select them using `glossaries` and `protected_terms`. Rename each legacy
entry's `summary` to `description` to preserve its prompt context. Remove
`--glossary` and `--modules` from invocations.
- Move profiles and backends out of the application configuration and retired
`profiles_dir` layout into PromptKit resources. Use its current list records,
IDs, credential sources, and backend admission settings. Select proposal and
validation profiles in application `llm` settings.
- Use the shared `--debug` flag for capture; `diagnostics.work_dir` remains the
parent directory. Review report and output destinations before running.
- Completion counts are hidden by default. Use `--verbose` to see them on
stderr, including when ordinary reports are disabled. `--debug` also shows
counts unless followed by `--quiet`. See [CLI reporting](../cli.md#processing).
Inspect configuration and resources before processing, then try a controlled
small transcript. Processing preflight checks every glossary correction and