Compare commits
79 Commits
b750c42ad6
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 7cc877ea7f | |||
| 7ee362f1c3 | |||
| 084e6d178b | |||
| 86ec48d2e4 | |||
| 3868822277 | |||
| d83c5f0062 | |||
| 981eb6be8f | |||
| 6b027873a5 | |||
| d00cc8037d | |||
| b4b618a913 | |||
| 8ba001750e | |||
| fa9ed78a6d | |||
| 4dae8e0d36 | |||
| 35eaefd05d | |||
| f85f93bdfb | |||
| 0e34ea1d48 | |||
| 97a93d3393 | |||
| 435ec79185 | |||
| 33d2ebf44c | |||
| e93fb8d5ab | |||
| 69dc5cc8ec | |||
| 5d62f9a88b | |||
| ba9079ee74 | |||
| 583c5bdf1b | |||
| bccf03a99f | |||
| 39a958675d | |||
| 413b0d7134 | |||
| ff4bdaa483 | |||
| ebcc5b32a0 | |||
| ce661252d0 | |||
| ed7e722077 | |||
| bcfca7a044 | |||
| 05f5607968 | |||
| 1657c9f65d | |||
| c3023cb609 | |||
| 6593ccbeaf | |||
| 341fe93e3b | |||
| 65d0e518e5 | |||
| 4a0e3c83db | |||
| f5451a0cf5 | |||
| 381668568f | |||
| 8afb49c018 | |||
| 535f47ef20 | |||
| dcb9bae215 | |||
| f1f71d8cdf | |||
| 39af6ef941 | |||
| e1c934a492 | |||
| dd760d84e0 | |||
| 6db49b3949 | |||
| f1672f6f95 | |||
| 428f435734 | |||
| c4abdc19df | |||
| 08327c2e63 | |||
| 2850498043 | |||
| fe9817f354 | |||
| 40cbf42438 | |||
| 44a318694b | |||
| 9389f69eb0 | |||
| d53a64650b | |||
| e349bf03ca | |||
| 23c4686b84 | |||
| 4c114b6319 | |||
| 3de5f9378d | |||
| ee9a786677 | |||
| debef98536 | |||
| e08f083ec8 | |||
| 9bbec2fe79 | |||
| 77201baddf | |||
| ce91f04974 | |||
| 65502ce5b4 | |||
| 3695303100 | |||
| 95e865495c | |||
| 6547a8abd3 | |||
| b24c9a8fdf | |||
| a5a252ab30 | |||
| 2237a902b6 | |||
| f060d7eb1f | |||
| 2e92f2f200 | |||
| 7f90c70c30 |
@@ -3,12 +3,12 @@ when:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
validate-release:
|
validate-release:
|
||||||
image: golang:1.26.7
|
image: golang:1.27.4
|
||||||
commands:
|
commands:
|
||||||
- ./scripts/check-release-candidate.sh "$CI_COMMIT_TAG"
|
- ./scripts/check-release-candidate.sh "$CI_COMMIT_TAG"
|
||||||
|
|
||||||
build-release-assets:
|
build-release-assets:
|
||||||
image: golang:1.26.7
|
image: golang:1.27.4
|
||||||
depends_on:
|
depends_on:
|
||||||
- validate-release
|
- validate-release
|
||||||
commands:
|
commands:
|
||||||
|
|||||||
@@ -3,6 +3,6 @@ when:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
shuffled-race-tests:
|
shuffled-race-tests:
|
||||||
image: golang:1.26
|
image: golang:1.27.4
|
||||||
commands:
|
commands:
|
||||||
- go test -race -shuffle=on -count=3 ./...
|
- go test -race -shuffle=on -count=3 ./...
|
||||||
|
|||||||
@@ -3,38 +3,31 @@ when:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
tests:
|
tests:
|
||||||
image: golang:1.26
|
image: golang:1.27.4
|
||||||
commands:
|
commands:
|
||||||
- go test ./...
|
- go test ./...
|
||||||
|
|
||||||
race-tests:
|
race-tests:
|
||||||
image: golang:1.26
|
image: golang:1.27.4
|
||||||
depends_on: tests
|
depends_on: tests
|
||||||
commands:
|
commands:
|
||||||
- go test -race ./...
|
- go test -race ./...
|
||||||
|
|
||||||
static-analysis:
|
static-analysis:
|
||||||
image: golang:1.26
|
image: golang:1.27.4
|
||||||
depends_on: tests
|
depends_on: tests
|
||||||
commands:
|
commands:
|
||||||
- go vet ./...
|
- go vet ./...
|
||||||
|
|
||||||
build:
|
build:
|
||||||
image: golang:1.26
|
image: golang:1.27.4
|
||||||
depends_on: tests
|
depends_on: tests
|
||||||
commands:
|
commands:
|
||||||
- go build ./...
|
- go build ./...
|
||||||
|
|
||||||
documentation-and-examples:
|
|
||||||
image: golang:1.26
|
|
||||||
depends_on: tests
|
|
||||||
commands:
|
|
||||||
- go test ./internal/doccheck
|
|
||||||
- go test ./internal/config -run '^TestExamplesLoadAndValidate$'
|
|
||||||
|
|
||||||
cross-build:
|
cross-build:
|
||||||
image: golang:1.26
|
image: golang:1.27.4
|
||||||
depends_on: [race-tests, static-analysis, build, documentation-and-examples]
|
depends_on: [race-tests, static-analysis, build]
|
||||||
commands:
|
commands:
|
||||||
- |
|
- |
|
||||||
set -eu
|
set -eu
|
||||||
|
|||||||
33
AGENTS.md
33
AGENTS.md
@@ -1,5 +1,30 @@
|
|||||||
Please review `docs/development.md` for initial orientation in this repository
|
Start with `docs/development.md` for orientation and use its policy reading guide
|
||||||
and follow its task-specific reading guide.
|
to select the policies applicable to the task. Do not read the entire suite by
|
||||||
|
default.
|
||||||
|
|
||||||
Review and follow `docs/policy/agents.md` before recommending, planning, or
|
Read and follow `docs/policy/agents.md` before recommending, planning, or
|
||||||
implementing any changes to this repository.
|
implementing repository changes.
|
||||||
|
|
||||||
|
<!-- codebase-memory-mcp:start -->
|
||||||
|
# Codebase Knowledge Graph (codebase-memory-mcp)
|
||||||
|
|
||||||
|
This project uses codebase-memory-mcp to maintain a knowledge graph of the codebase.
|
||||||
|
ALWAYS prefer MCP graph tools over grep/glob/file-search for code discovery.
|
||||||
|
|
||||||
|
## Priority Order
|
||||||
|
1. `search_graph` — find functions, classes, routes, variables by pattern
|
||||||
|
2. `trace_path` — trace who calls a function or what it calls
|
||||||
|
3. `get_code_snippet` — read specific function/class source code
|
||||||
|
4. `query_graph` — run Cypher queries for complex patterns
|
||||||
|
5. `get_architecture` — high-level project summary
|
||||||
|
|
||||||
|
## When to fall back to grep/glob
|
||||||
|
- Searching for string literals, error messages, config values
|
||||||
|
- Searching non-code files (Dockerfiles, shell scripts, configs)
|
||||||
|
- When MCP tools return insufficient results
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
- Find a handler: `search_graph(name_pattern=".*OrderHandler.*")`
|
||||||
|
- Who calls it: `trace_path(function_name="OrderHandler", direction="inbound")`
|
||||||
|
- Read source: `get_code_snippet(qualified_name="pkg/orders.OrderHandler")`
|
||||||
|
<!-- codebase-memory-mcp:end -->
|
||||||
|
|||||||
23
COPYRIGHT
Normal file
23
COPYRIGHT
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
Narratio
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
Narratio is free software: you can redistribute it and/or modify it
|
||||||
|
under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
The GNU General Public License version 3 is provided in LICENSE.
|
||||||
|
|
||||||
|
Narratio is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
Third-party code and assets are subject to their respective license terms.
|
||||||
|
|
||||||
|
Policy documents adapted from Standard Repository Policies remain licensed
|
||||||
|
under CC-BY-SA-4.0. See docs/oss/attribution.md for the affected material,
|
||||||
|
upstream credit, and license links.
|
||||||
646
LICENSE
646
LICENSE
@@ -1,232 +1,674 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
GNU GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and modification follow.
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
“This License” refers to version 3 of the GNU General Public License.
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
1. Source Code.
|
1. Source Code.
|
||||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
|
||||||
|
|
||||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that same work.
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
2. Basic Permissions.
|
2. Basic Permissions.
|
||||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
4. Conveying Verbatim Copies.
|
||||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
5. Conveying Modified Source Versions.
|
||||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
6. Conveying Non-Source Forms.
|
||||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
7. Additional Terms.
|
7. Additional Terms.
|
||||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
8. Termination.
|
8. Termination.
|
||||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
9. Acceptance Not Required for Having Copies.
|
||||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
11. Patents.
|
11. Patents.
|
||||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
|
||||||
|
|
||||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
12. No Surrender of Others' Freedom.
|
||||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
13. Use with the GNU Affero General Public License.
|
||||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
14. Revised Versions of this License.
|
||||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
15. Disclaimer of Warranty.
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
16. Limitation of Liability.
|
16. Limitation of Liability.
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
17. Interpretation of Sections 15 and 16.
|
||||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
narratio
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
Copyright (C) 2026 eric
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
narratio Copyright (C) 2026 eric
|
<program> Copyright (C) <year> <name of author>
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -40,3 +40,7 @@ This requires resolvable `pipeline.yml`, `campaign.yml`, and concrete
|
|||||||
and maintenance rules.
|
and maintenance rules.
|
||||||
- [Testing policy](docs/policy/testing.md) — test value, boundaries, and
|
- [Testing policy](docs/policy/testing.md) — test value, boundaries, and
|
||||||
sufficiency.
|
sufficiency.
|
||||||
|
|
||||||
|
Narratio is licensed under the [GPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
|||||||
84
docs/adr/0001-classify-session-content.md
Normal file
84
docs/adr/0001-classify-session-content.md
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
# 0001. Classify session content by purpose and lifecycle
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Proposed
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-10-01
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Narratio coordinates applications that produce transcripts, artifacts,
|
||||||
|
diagnostics, and working files. The current session layout mixes some of these
|
||||||
|
roles, including complete Notarius bundles under `artifacts/`. Operators use
|
||||||
|
transcripts and artifacts to evaluate results during development and need
|
||||||
|
predictable locations for diagnostics.
|
||||||
|
|
||||||
|
A shared classification model will guide the workspace design and subsequent
|
||||||
|
adapter changes. The [operator guide](../operations.md#local-state-layout)
|
||||||
|
describes the implemented layout.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Classify content by its primary purpose and lifecycle:
|
||||||
|
|
||||||
|
| Category | Purpose |
|
||||||
|
| --- | --- |
|
||||||
|
| Inputs | Material consumed by an application, including audio, configuration, and reference documents. |
|
||||||
|
| Outputs | Completed substantive products, including intermediate artifacts exposed for further use. |
|
||||||
|
| Logs | Records of execution, including process logs, execution reports, warnings, and diagnostic summaries. |
|
||||||
|
| Cache | Reusable information whose absence permits ordinary recomputation or retrieval. |
|
||||||
|
| State | Application condition, progress, recovery records, and unfinished work. |
|
||||||
|
|
||||||
|
Classification is relative to the consuming application. An output of one stage
|
||||||
|
can serve as an input to another while retaining its output location. Completed
|
||||||
|
outputs reused to skip work remain Outputs. Narratio's manifest is State and
|
||||||
|
records whether those outputs are reusable.
|
||||||
|
|
||||||
|
Classify checkpoints according to their recovery behavior. A checkpoint needed
|
||||||
|
to continue a particular interrupted operation is State. A saved work result
|
||||||
|
that can be reused or recomputed is Cache. Recomputation cost informs retention
|
||||||
|
policy. File-specific classification remains necessary for stores serving both
|
||||||
|
purposes.
|
||||||
|
|
||||||
|
Treat Debug as a capture and retention mode that can include detailed Logs,
|
||||||
|
snapshots of State, and other diagnostic evidence. Retained debug snapshots have
|
||||||
|
a diagnostic role; live recovery records retain their State role.
|
||||||
|
|
||||||
|
Apply these directory principles to Narratio:
|
||||||
|
|
||||||
|
- Store completed artifacts, including intermediate artifacts like
|
||||||
|
`session_bounds.json`, directly in a flat `artifacts/` directory.
|
||||||
|
- Store combined transcripts directly in `transcripts/`, with a subdirectory
|
||||||
|
for the initial per-speaker transcripts.
|
||||||
|
- Store prepared external audio in `audio/` and other prepared external inputs
|
||||||
|
in `inputs/`.
|
||||||
|
- Organize Logs under `logs/` by stage. Execution reports belong to this category.
|
||||||
|
- Organize Cache under a cache root by the application that owns its format and
|
||||||
|
reuse behavior.
|
||||||
|
- Treat scratch files and unfinished outputs as State until completion permits
|
||||||
|
promotion to Outputs.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Group outputs by producer. This exposes subprocess packaging to operators;
|
||||||
|
flat artifact and transcript locations better support comparison and review.
|
||||||
|
- Group Logs by application. Stage names match the operator's workflow and
|
||||||
|
collect diagnostics from stages that invoke multiple applications.
|
||||||
|
- Classify all checkpoints as State. Recovery behavior provides a more useful
|
||||||
|
distinction for eviction and reuse decisions.
|
||||||
|
- Treat all Debug material as Logs. A separate debug location can accommodate
|
||||||
|
retained state snapshots and larger diagnostic bundles when needed.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Each managed file family needs an identified role, owner, scope, and retention
|
||||||
|
rule. Subprocess bundles require classification before their contents are
|
||||||
|
placed in Narratio's output and diagnostic directories.
|
||||||
|
|
||||||
|
Physical roots, retention rules, the mechanism for presenting latest logs,
|
||||||
|
debug placement, and ambiguous checkpoint classifications remain open. The file
|
||||||
|
inventory and subsequent roadmap will resolve these choices and define the
|
||||||
|
migration. Current versus historical views are separate from content categories.
|
||||||
76
docs/adr/0002-assign-subprocess-content-ownership.md
Normal file
76
docs/adr/0002-assign-subprocess-content-ownership.md
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
# 0002. Assign subprocess content ownership
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Proposed
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-10-03
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
[ADR 0001](0001-classify-session-content.md) defines content categories and
|
||||||
|
operator-facing directory principles. Narratio also needs an ownership boundary
|
||||||
|
for the applications it invokes. That boundary determines who selects locations,
|
||||||
|
manages retained files, and controls cleanup.
|
||||||
|
|
||||||
|
The current subprocess workflows can execute with fresh working state. Notarius
|
||||||
|
can reuse persistent chunk-plan and checkpoint caches. Narratio maintains its own
|
||||||
|
session progress and recovery records.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Assign responsibility by content category:
|
||||||
|
|
||||||
|
| Category | Responsibility |
|
||||||
|
| --- | --- |
|
||||||
|
| Inputs | Narratio supplies paths to prepared inputs, transcripts, and artifacts. |
|
||||||
|
| Outputs | Narratio selects destinations and promotes completed products into the output locations defined by ADR 0001. |
|
||||||
|
| Logs | Narratio selects stage-based destinations and captures subprocess output streams. |
|
||||||
|
| Debug | Narratio selects the destination when capture is enabled; the subprocess defines the diagnostic contents. |
|
||||||
|
| Subprocess State | Each application manages its working directory, temporary files, and execution lifecycle through its own configuration and defaults. |
|
||||||
|
| Subprocess Cache | Each application manages its configured persistent cache, including its format, identity, and reuse behavior. |
|
||||||
|
|
||||||
|
Narratio retains ownership of its own State, including the session manifest,
|
||||||
|
recovery bookkeeping, and staging files it manages.
|
||||||
|
|
||||||
|
Recommend a dedicated cache root for each cache-aware application, configurable
|
||||||
|
through that application's supported controls. For system-wide deployments,
|
||||||
|
`/var/cache/<application>` is a suggested location; `/var/cache/notarius` is an
|
||||||
|
example for Notarius. Each application defines its cache configuration, defaults,
|
||||||
|
and internal layout. Operators select locations and retention settings through
|
||||||
|
those controls. Narratio's session cleanup leaves subprocess caches under their
|
||||||
|
separate lifecycle policies.
|
||||||
|
|
||||||
|
Subprocesses retain ownership of their file formats and bundle structures.
|
||||||
|
Narratio can receive a complete result bundle at a selected staging destination
|
||||||
|
and promote the selected products into its canonical output directories.
|
||||||
|
Diagnostic snapshots of subprocess State follow the Debug destination selected
|
||||||
|
by Narratio.
|
||||||
|
|
||||||
|
Narratio's `runs/` directory can hold staging outputs and retained execution
|
||||||
|
evidence. Subprocess working directories follow the application's configuration
|
||||||
|
and may reside elsewhere. Narratio cleanup manages Narratio-owned material;
|
||||||
|
subprocess State and Cache follow their separate lifecycle policies.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Place all subprocess working files and caches inside each Narratio session.
|
||||||
|
This makes sessions easier to collect as a unit, but couples application
|
||||||
|
internals and cache retention to Narratio's session lifecycle.
|
||||||
|
- Allow subprocesses to choose output, log, and debug destinations independently.
|
||||||
|
This simplifies invocation but scatters the material operators inspect.
|
||||||
|
- Give Narratio control of downstream bundle formats. This simplifies some
|
||||||
|
destination mappings but increases integration coupling. Selecting and
|
||||||
|
promoting products preserves application ownership of those formats.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Adapters need supported controls for Narratio-selected output, log, and debug
|
||||||
|
locations. Upstream changes may be needed where those destinations are coupled
|
||||||
|
to application working directories or to one another.
|
||||||
|
|
||||||
|
Workspace layout and file classification can proceed independently of subprocess
|
||||||
|
working-directory conventions. Exact debug placement, retained diagnostic views,
|
||||||
|
and migration steps remain for the workspace design and roadmap.
|
||||||
38
docs/adr/0003-assign-configuration-ownership.md
Normal file
38
docs/adr/0003-assign-configuration-ownership.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# 0003. Assign configuration ownership
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-11-19
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Configuration loading, inspection, and domain execution need explicit ownership
|
||||||
|
so that effective configuration has one authority.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
- **ConfigKit owns configuration policy and resolution through the final
|
||||||
|
handoff.** Narratio supplies its schema, defaults, and configuration rules
|
||||||
|
through ConfigKit's supported extension points. The completed ConfigKit
|
||||||
|
result is authoritative.
|
||||||
|
- **Narratio owns domain interpretation and execution.** It consumes the
|
||||||
|
completed configuration without mutation and produces separate domain
|
||||||
|
objects. It must not construct a replacement effective configuration.
|
||||||
|
- **CommandKit owns CLI mechanics and presentation; `ckconfig` exposes
|
||||||
|
ConfigKit's inspection features.** Narratio supplies selection and acquisition
|
||||||
|
wiring and exposes those features through native adapters, without altering
|
||||||
|
their semantics or substituting its own inspection views.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
Post-handoff configuration resolution and custom inspection projections are
|
||||||
|
rejected because they create competing configuration authorities.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Domain catalogs and plans remain separate from native configuration inspection.
|
||||||
|
Missing configuration or inspection capabilities are addressed upstream.
|
||||||
30
docs/cli.md
30
docs/cli.md
@@ -59,8 +59,8 @@ Rules:
|
|||||||
base configuration, while an unknown named overlay fails. The same selection
|
base configuration, while an unknown named overlay fails. The same selection
|
||||||
applies to all common-flag commands, including `regenerate-artifacts`.
|
applies to all common-flag commands, including `regenerate-artifacts`.
|
||||||
- `--secrets-dir` selects ConfigKit credential-file bootstrap explicitly. A
|
- `--secrets-dir` selects ConfigKit credential-file bootstrap explicitly. A
|
||||||
relative value uses caller CWD. Without the flag, a present `secrets/`
|
relative value uses caller CWD. Without the flag, Narratio uses the optional
|
||||||
directory beside the resolved root pipeline is used; an absent one is skipped.
|
`/usr/local/etc/narratio/secrets` directory.
|
||||||
- `clean --all` cannot be combined with campaign/session selectors.
|
- `clean --all` cannot be combined with campaign/session selectors.
|
||||||
- notification delivery is currently limited to the configured `noop` mode; see
|
- notification delivery is currently limited to the configured `noop` mode; see
|
||||||
the [configuration reference](./config.md#notifications).
|
the [configuration reference](./config.md#notifications).
|
||||||
@@ -117,8 +117,13 @@ family declarations, and runtime provenance.
|
|||||||
effective values. Its header identifies the root, ordered imports, selected
|
effective values. Its header identifies the root, ordered imports, selected
|
||||||
overlay and its file, selected campaign, party source, and digest. The
|
overlay and its file, selected campaign, party source, and digest. The
|
||||||
remaining tab-separated records are sorted as `path`, `role`, and `source`.
|
remaining tab-separated records are sorted as `path`, `role`, and `source`.
|
||||||
Roles distinguish root, import, overlay, centralized default, campaign, party,
|
Roles distinguish root, import, overlay, normalization, centralized default,
|
||||||
and generated family ownership. A generated party member has
|
campaign, party, and generated family ownership. Records labeled
|
||||||
|
`resolution` retain their effective pre-normalization source contributors;
|
||||||
|
superseded definitions remain historical evidence in the artifact catalog.
|
||||||
|
Records labeled
|
||||||
|
`empty_import` identify the source-local declaration path, selector, and
|
||||||
|
location of an optional import that selected no sources. A generated party member has
|
||||||
one family record and one party record at the same logical path. The output
|
one family record and one party record at the same logical path. The output
|
||||||
never reads or prints secret values.
|
never reads or prints secret values.
|
||||||
|
|
||||||
@@ -127,9 +132,11 @@ artifact key. Its tab-separated header is `key`, `source`, `definitions`,
|
|||||||
`enabled`, `output`, `dependencies`, `family`, `character`, `family_source`, and
|
`enabled`, `output`, `dependencies`, `family`, `character`, `family_source`, and
|
||||||
`party_source`. Definitions and effective dependencies are sorted comma-separated
|
`party_source`. Definitions and effective dependencies are sorted comma-separated
|
||||||
lists, and control characters in fields are escaped. Family-member rows identify
|
lists, and control characters in fields are escaped. Family-member rows identify
|
||||||
their family, character, defining family file, and party file. An empty catalog
|
their family, character, contributing family source files, and party file.
|
||||||
prints only the header. Ordinary artifacts can be inspected without a campaign;
|
Family source paths are comma-separated when ConfigKit reports a composite
|
||||||
party-driven families retain the campaign requirement. See
|
origin. An empty catalog prints only the header. Ordinary artifacts can be
|
||||||
|
inspected without a campaign; party-driven families retain the campaign
|
||||||
|
requirement. See
|
||||||
[Scriptorium Artifact Entries](./config.md#scriptorium-artifact-entries) for the
|
[Scriptorium Artifact Entries](./config.md#scriptorium-artifact-entries) for the
|
||||||
configuration layout.
|
configuration layout.
|
||||||
|
|
||||||
@@ -149,8 +156,10 @@ removed <path> <left-value>
|
|||||||
changed <path> <left-value> <right-value>
|
changed <path> <left-value> <right-value>
|
||||||
```
|
```
|
||||||
|
|
||||||
Mappings are flattened to their logical field paths; lists remain one atomic
|
Paths use JSON Pointer notation, with `~0` for `~` and `~1` for `/`. Native
|
||||||
value. The command compares defaulted concrete artifacts and publish rules, not
|
comparison reports a changed mapping region as one value when a whole mapping
|
||||||
|
is added or removed; lists are compared as whole values. A `hidden_changed=true`
|
||||||
|
field indicates a change hidden by redaction. The command compares defaulted concrete artifacts and publish rules, not
|
||||||
overlay names, source-file layout, or formatting. It succeeds when differences
|
overlay names, source-file layout, or formatting. It succeeds when differences
|
||||||
are found, making it suitable for review and migration checks.
|
are found, making it suitable for review and migration checks.
|
||||||
|
|
||||||
@@ -364,6 +373,9 @@ Rules:
|
|||||||
- `--audio-dir` and `--audio-s3-prefix` are mutually exclusive.
|
- `--audio-dir` and `--audio-s3-prefix` are mutually exclusive.
|
||||||
- if campaign `session_template_file` is configured, `session init` renders it.
|
- if campaign `session_template_file` is configured, `session init` renders it.
|
||||||
- generated session YAML must be concrete (no unresolved `{{ ... }}` placeholders).
|
- generated session YAML must be concrete (no unresolved `{{ ... }}` placeholders).
|
||||||
|
- template imports and relative resources resolve in the template's local
|
||||||
|
authoring context. Generated output contains standalone effective values.
|
||||||
|
- relative `--audio-dir` paths resolve from the invocation directory.
|
||||||
|
|
||||||
### `session restore`
|
### `session restore`
|
||||||
|
|
||||||
|
|||||||
223
docs/config.md
223
docs/config.md
@@ -12,10 +12,20 @@ Narratio resolves three YAML documents:
|
|||||||
|
|
||||||
### `pipeline.yml`
|
### `pipeline.yml`
|
||||||
|
|
||||||
When `--config` is omitted, search order is:
|
An explicit `--config` selects exactly that file, including a custom filename.
|
||||||
|
Otherwise ConfigKit searches these locations in order:
|
||||||
|
|
||||||
1. `/usr/local/etc/narratio/pipeline.yml`
|
1. The working directory, for `narratio.yml` then `narratio.yaml`.
|
||||||
2. `/etc/narratio/pipeline.yml`
|
2. The Go user-config directory's `narratio/` subdirectory, for those named
|
||||||
|
files followed by `config.yml`, `config.yaml`, `main.yml`, and `main.yaml`.
|
||||||
|
3. The Go user-config directory itself, for the named files.
|
||||||
|
4. `/usr/local/etc/narratio/` and then `/etc/narratio/`, each for named files
|
||||||
|
followed by the generic filenames above.
|
||||||
|
5. `/etc/`, for the named files.
|
||||||
|
|
||||||
|
On Linux, the user-config directory normally follows `XDG_CONFIG_HOME`, or
|
||||||
|
`~/.config` when it is unset. A selected invalid file fails loading; discovery
|
||||||
|
does not continue to another candidate.
|
||||||
|
|
||||||
### `campaign.yml`
|
### `campaign.yml`
|
||||||
|
|
||||||
@@ -32,15 +42,15 @@ When `--session` is omitted, local search order is:
|
|||||||
1. `/usr/local/etc/narratio/session.yml`
|
1. `/usr/local/etc/narratio/session.yml`
|
||||||
2. `/etc/narratio/session.yml`
|
2. `/etc/narratio/session.yml`
|
||||||
|
|
||||||
If local session discovery fails and a `session_id` is known, Narratio attempts remote session loading from:
|
If no local session exists and a `session_id` is known, Narratio loads the
|
||||||
|
session from configured object storage. Downloaded session bytes are contextless
|
||||||
|
snapshots, with remote object
|
||||||
|
provenance retained independently of locally materialized checksums.
|
||||||
|
|
||||||
- `{root_prefix}/campaigns/{campaign}/sessions/{session_id}/session.yml`
|
Remote loading prefers an authored session-root `session.yml`, including updates
|
||||||
|
from `session init --remote --force`. When that object is absent, loading falls
|
||||||
using configured object storage.
|
back to the current commit's standalone prepared session. Published snapshots
|
||||||
|
remain immutable; restore validates the pointer-selected committed state.
|
||||||
The downloaded remote session file is command-scoped: Narratio removes it after
|
|
||||||
the command finishes and records only the remote object provenance alongside
|
|
||||||
the durable copied session input.
|
|
||||||
|
|
||||||
### Read-only effective pipeline inspection
|
### Read-only effective pipeline inspection
|
||||||
|
|
||||||
@@ -67,13 +77,15 @@ not promised to be a reloadable authoring document. `config sources` prints a st
|
|||||||
source projection instead of effective values: root/import/overlay/default
|
source projection instead of effective values: root/import/overlay/default
|
||||||
ownership plus campaign/party and generated-family records. Canonical derived
|
ownership plus campaign/party and generated-family records. Canonical derived
|
||||||
players trace to the party. `config artifacts` lists the concrete artifact map,
|
players trace to the party. `config artifacts` lists the concrete artifact map,
|
||||||
effective dependencies, and defining sources. The [CLI reference](cli.md#config-validate-config-show-config-sources-config-artifacts-and-config-diff)
|
effective dependencies, and definition contributor paths, which may identify
|
||||||
|
several files for one family member. The [CLI reference](cli.md#config-validate-config-show-config-sources-config-artifacts-and-config-diff)
|
||||||
owns command syntax and output conventions.
|
owns command syntax and output conventions.
|
||||||
|
|
||||||
`config diff` compares normalized field values rather than YAML text or source
|
`config diff` compares normalized field values rather than YAML text or source
|
||||||
ownership. It emits sorted `added`, `removed`, and `changed` records, uses
|
ownership. It emits native ordered `added`, `removed`, and `changed` records with
|
||||||
compact deterministic JSON values, treats lists atomically, and reports `no
|
JSON Pointer paths and compact JSON values. Lists are compared atomically, and
|
||||||
differences` when the complete effective configurations are equal. Concrete
|
changed regions may contain whole values. It reports `no differences` when the
|
||||||
|
complete effective configurations are equal. Concrete
|
||||||
family members and generated publish rules participate after expansion; moving
|
family members and generated publish rules participate after expansion; moving
|
||||||
an equal value between eligible root/import sources does not create a
|
an equal value between eligible root/import sources does not create a
|
||||||
difference.
|
difference.
|
||||||
@@ -104,23 +116,14 @@ remote state with an unsafe legacy identity must be migrated before use.
|
|||||||
|
|
||||||
- ConfigKit performs strict typed YAML decoding and accepts exactly one document;
|
- ConfigKit performs strict typed YAML decoding and accepts exactly one document;
|
||||||
unknown fields, duplicate keys, and trailing documents fail load.
|
unknown fields, duplicate keys, and trailing documents fail load.
|
||||||
- A pipeline file may explicitly import additive YAML fragments through the
|
- Local pipeline, campaign, session, and party documents may declare native
|
||||||
root-only `configkit.imports` list. Imported files contribute fields to one
|
imports and sibling inheritance. Only the pipeline selects an overlay.
|
||||||
logical pipeline document; they do not override fields supplied by the root
|
- An omitted overlay, empty overlay option, and exact `default` select the base;
|
||||||
or another import.
|
another name selects `overlays/<name>.yml` relative to the pipeline root.
|
||||||
- An omitted overlay, an empty overlay option, and the exact name `default`
|
|
||||||
select the base configuration. Any other name selects
|
|
||||||
`overlays/<name>.yml` relative to the pipeline root. Move previously selected
|
|
||||||
`profiles/<name>.yml` files there; the old directory is not searched, and
|
|
||||||
`--profile` is no longer accepted for Narratio pipeline selection. Explicit
|
|
||||||
imports from a directory named `profiles` remain valid.
|
|
||||||
- Campaign, session, and canonical-party documents are strict single-source
|
|
||||||
ConfigKit schemas. They do not enable imports, overlays, or `configkit`
|
|
||||||
directives.
|
|
||||||
- Configured timeout and retry-delay durations must be positive. An omitted
|
- Configured timeout and retry-delay durations must be positive. An omitted
|
||||||
artifact timeout continues to inherit its configured Scriptorium timeout.
|
artifact timeout continues to inherit its configured Scriptorium timeout.
|
||||||
- Session files must be concrete; unresolved `{{ ... }}` placeholders fail load.
|
- Session files must be concrete; unresolved `{{ ... }}` placeholders fail load.
|
||||||
- Session and party inputs inspected before typed loading are limited to 8 MiB.
|
- ConfigKit applies its acquisition limits to configuration sources and imports.
|
||||||
- Pipeline defaults are applied before validation.
|
- Pipeline defaults are applied before validation.
|
||||||
- Defaults apply only to absent fields. Explicit empty strings, zero values,
|
- Defaults apply only to absent fields. Explicit empty strings, zero values,
|
||||||
`false`, and `null` retain ConfigKit's typed meaning and are then checked by
|
`false`, and `null` retain ConfigKit's typed meaning and are then checked by
|
||||||
@@ -142,57 +145,74 @@ remote state with an unsafe legacy identity must be migrated before use.
|
|||||||
|
|
||||||
### Pipeline imports and overlays
|
### Pipeline imports and overlays
|
||||||
|
|
||||||
Large pipeline configurations may be split into explicitly named fragments and
|
Local pipeline, campaign, session, and party files can use source-root
|
||||||
may use fixed-path selected overlays:
|
`config.imports` and `config.sequences`. Every acquired document has its own
|
||||||
|
source-root controls, including imported fragments. Nested `config` keys are
|
||||||
|
ordinary data. `extends` is reserved for native sibling inheritance; parents
|
||||||
|
remain ordinary entries subject to Narratio's effective-domain validation.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
configkit:
|
config:
|
||||||
imports:
|
imports:
|
||||||
- path: config/storage.yml
|
- path: artifacts/session-recap.yml
|
||||||
- path: config/integrations.yaml
|
destination: [scriptorium, artifacts, session_recap]
|
||||||
|
required: true
|
||||||
campaigns:
|
- dir: artifacts/families
|
||||||
root: /usr/local/share/narratio/campaigns
|
pattern: "*.yml"
|
||||||
```
|
```
|
||||||
|
|
||||||
The maintained [production/testing bundle](../examples/production-testing/pipeline.yml)
|
Imports support `path`, `dir`, and `glob` selectors, applicable filters and
|
||||||
is a complete copyable example of this structure, including canonical-party
|
relative destinations. Paths are relative to the declaring source. Missing or
|
||||||
artifact families.
|
empty selections are optional by default; use `required: true` when a selection
|
||||||
|
is essential. Selected invalid input fails. Destinations place content under
|
||||||
|
literal mapping keys, independent of filenames; nested imports can declare
|
||||||
|
relative destinations. Strict peer contributions must satisfy ConfigKit's
|
||||||
|
composition rules, and Narratio validates the resulting effective entries.
|
||||||
|
|
||||||
Imports are resolved relative to the directory containing the root pipeline
|
A selected pipeline overlay is applied after base composition. It may declare
|
||||||
file and are loaded in declaration order. Narratio does not scan directories or
|
root `config.sequences` but cannot import other files. Ordinary overlay lists
|
||||||
infer fragments. Each import must be a confined regular `.yml` or `.yaml` file:
|
replace the lower list; declared collections can use native `replace`, `append`,
|
||||||
absolute paths, traversal, symlinks, directories, duplicate files, and an
|
or `upsert`. Upsert replaces a whole matching record; an empty append or upsert
|
||||||
import of the root pipeline itself are rejected. Imported files cannot declare
|
does not clear the lower list. Mapping and identified-list inheritance follow
|
||||||
another `configkit` control section.
|
native sibling rules. See the pinned [ConfigKit configuration contract](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/docs/config.md)
|
||||||
|
and [consumer guide](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/docs/consumers/README.md)
|
||||||
|
for full selection, composition, collection, and reserved-key semantics.
|
||||||
|
The [maintained bundle](../examples/production-testing/pipeline.yml) illustrates
|
||||||
|
these controls, family expansion, and a split roster.
|
||||||
|
|
||||||
Base merging is additive. A map may be extended by multiple files when every
|
Relative host-resource paths, including integration configuration files,
|
||||||
leaf is distinct, but a scalar, list, or map/list/scalar kind cannot be claimed
|
workspace/campaign/spool/cache roots, campaign template and stable inputs, and
|
||||||
more than once, even when the repeated values are identical. Conflict errors
|
session stable inputs and local audio references, resolve from the effective
|
||||||
name the full field path and every source that claimed it. Narratio additionally
|
value's defining source. Inherited values follow their origin. When no distinct
|
||||||
rejects an artifact or artifact-family key declared by more than one base file,
|
usable source context exists, the main source is the fallback; if it too is
|
||||||
even when those files contribute disjoint children.
|
contextless, the invocation directory is used. Explicit CLI-relative file paths
|
||||||
|
use the invocation directory. Artifact outputs, publish destinations, logical
|
||||||
|
IDs, and binary names retain their domain meanings.
|
||||||
|
|
||||||
Overlay names are case-sensitive and use ConfigKit's safe fixed-path naming
|
The effective digest excludes source layout, overlay identity, and secret values;
|
||||||
rules. Only the selected overlay is opened; a malformed unselected overlay does
|
credential reference names and resolved resource paths participate. Prepared
|
||||||
not affect a base or different-overlay load. Maps merge recursively, overlay
|
campaign, session, and party documents contain effective standalone values rather
|
||||||
scalars replace base scalars, and overlay lists replace base lists completely.
|
than authored import directives. Session fields omitted by the author remain
|
||||||
Explicit `false`, zero, empty strings, empty containers, and null values remain
|
eligible to inherit the receiving campaign's values.
|
||||||
explicit inputs and are not refilled by defaults. Overlays cannot inherit,
|
|
||||||
stack, import files, or declare another ConfigKit control section.
|
|
||||||
|
|
||||||
During ConfigKit loading, Narratio applies fresh typed defaults, recorded
|
### Upgrade from earlier configuration
|
||||||
entry-level defaults and normalization, read-only file-local validation, and
|
|
||||||
ordinary path resolution before computing a deterministic effective
|
|
||||||
configuration digest. The digest represents the normalized, secret-free
|
|
||||||
runtime pipeline mapping; it excludes ConfigKit directives, source
|
|
||||||
provenance, overlay identity, and raw environment secret values. Equivalent
|
|
||||||
effective mappings therefore have the same digest regardless of how fields are
|
|
||||||
split among the root and imports.
|
|
||||||
|
|
||||||
An imported field has the same meaning it would have in a monolithic root
|
- Rename source-root `configkit:` controls to `config:`. Nested `config` data
|
||||||
pipeline. In particular, ordinary relative pipeline paths continue to resolve
|
and the Go `configkit` package and secret tags have different meanings.
|
||||||
from the root pipeline directory, not from the importing fragment's directory.
|
- Rename or move pipeline files to the discovery names above, or retain a custom
|
||||||
|
filename such as `pipeline.yml` and pass it with `--config`.
|
||||||
|
- Move conventional secrets to `/usr/local/etc/narratio/secrets`, supply them
|
||||||
|
through the environment, or pass the previous directory with `--secrets-dir`.
|
||||||
|
- Review relative resource references moved into fragments: their defining
|
||||||
|
source now supplies the base. Mark necessary imports `required: true`.
|
||||||
|
- Review lists and use `config.sequences` where append or whole-record upsert is
|
||||||
|
intended. Verify the effective result with the inspection commands.
|
||||||
|
- Prepared documents contain effective values; retain authored roots and their
|
||||||
|
companions separately for editing. Separately installed downstream tools own
|
||||||
|
their own configuration migrations.
|
||||||
|
|
||||||
|
These control-key changes require a major version for the eventual Narratio
|
||||||
|
release. This migration does not itself publish a release.
|
||||||
|
|
||||||
## Minimal Working Configuration
|
## Minimal Working Configuration
|
||||||
|
|
||||||
@@ -237,8 +257,8 @@ inputs:
|
|||||||
stage range, or eligible for resume. Omit the field or set it to `null` when
|
stage range, or eligible for resume. Omit the field or set it to `null` when
|
||||||
that deployment should not require the credential.
|
that deployment should not require the credential.
|
||||||
- Every command that loads a pipeline accepts `--secrets-dir <path>`. When the
|
- Every command that loads a pipeline accepts `--secrets-dir <path>`. When the
|
||||||
flag is omitted, Narratio uses a present `secrets/` directory beside the
|
flag is omitted, Narratio uses `/usr/local/etc/narratio/secrets` when present;
|
||||||
resolved root `pipeline.yml`; an absent conventional directory is ignored.
|
an absent conventional directory is ignored.
|
||||||
Explicit relative paths are resolved from the caller's working directory,
|
Explicit relative paths are resolved from the caller's working directory,
|
||||||
and a missing or empty explicit selection is an error.
|
and a missing or empty explicit selection is an error.
|
||||||
- Each immediate regular file whose name is a valid environment-variable name
|
- Each immediate regular file whose name is a valid environment-variable name
|
||||||
@@ -294,7 +314,7 @@ Rules:
|
|||||||
|
|
||||||
| Field | Type | Required | Default / Rule |
|
| Field | Type | Required | Default / Rule |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `configkit.imports[].path` | string | No | explicit additive pipeline fragment relative to the root pipeline directory; `.yml` or `.yaml` regular files only |
|
| `config.imports` | list | No | native source-root import selections; see [imports and overlays](#pipeline-imports-and-overlays) |
|
||||||
| `pipeline.workspace.root` | string | No | `/var/lib/narratio` |
|
| `pipeline.workspace.root` | string | No | `/var/lib/narratio` |
|
||||||
| `pipeline.workspace.cleanup_after_publish` | bool | No | `false`; selects the published run's workspace target for final cleanup and requires effective `pipeline.publish.enabled=true` and `pipeline.publish.upload_run=true` |
|
| `pipeline.workspace.cleanup_after_publish` | bool | No | `false`; selects the published run's workspace target for final cleanup and requires effective `pipeline.publish.enabled=true` and `pipeline.publish.upload_run=true` |
|
||||||
| `pipeline.campaigns.root` | string | No | `/usr/local/share/narratio/campaigns` |
|
| `pipeline.campaigns.root` | string | No | `/usr/local/share/narratio/campaigns` |
|
||||||
@@ -358,11 +378,11 @@ Rules:
|
|||||||
| `pipeline.notarius.enabled` | bool | No | `false` |
|
| `pipeline.notarius.enabled` | bool | No | `false` |
|
||||||
| `pipeline.notarius.binary` | string | No | `notarius` |
|
| `pipeline.notarius.binary` | string | No | `notarius` |
|
||||||
| `pipeline.notarius.credentials[]` | list[secret reference] | No | empty; exact environment-variable names forwarded to Notarius |
|
| `pipeline.notarius.credentials[]` | list[secret reference] | No | empty; exact environment-variable names forwarded to Notarius |
|
||||||
| `pipeline.notarius.config_profile` | string | No | unset; exact Notarius ConfigKit profile selector |
|
| `pipeline.notarius.config_overlay` | string | No | unset; exact Notarius ConfigKit overlay selector |
|
||||||
| `pipeline.notarius.config_path` | string | Conditional | required when enabled; relative paths resolve from the pipeline file directory |
|
| `pipeline.notarius.config_path` | string | Conditional | required when enabled; relative paths resolve from their defining source |
|
||||||
| `pipeline.notarius.pipeline_id` | string | Conditional | required when enabled |
|
| `pipeline.notarius.pipeline_id` | string | Conditional | required when enabled |
|
||||||
| `pipeline.notarius.timeout` | duration | No | `3h`; must be positive |
|
| `pipeline.notarius.timeout` | duration | No | `3h`; must be positive |
|
||||||
| `pipeline.notarius.working_directory` | string | No | directory containing resolved `config_path`; relative paths resolve from the pipeline file directory |
|
| `pipeline.notarius.working_directory` | string | No | directory containing resolved `config_path`; relative paths resolve from their defining source |
|
||||||
| `pipeline.notarius.resume` | bool | No | `false`; request compatible Notarius checkpoint reuse during ordinary executed extraction |
|
| `pipeline.notarius.resume` | bool | No | `false`; request compatible Notarius checkpoint reuse during ordinary executed extraction |
|
||||||
| `pipeline.notarius.chunk_cache` | string | No | empty; when set, exactly `auto`, `bypass`, or `refresh` |
|
| `pipeline.notarius.chunk_cache` | string | No | empty; when set, exactly `auto`, `bypass`, or `refresh` |
|
||||||
| `pipeline.notarius.references` | map[string]string | No | empty; maps normalized Notarius selectors to supported prepared Narratio source IDs; maximum 256 entries |
|
| `pipeline.notarius.references` | map[string]string | No | empty; maps normalized Notarius selectors to supported prepared Narratio source IDs; maximum 256 entries |
|
||||||
@@ -374,6 +394,7 @@ Rules:
|
|||||||
| `pipeline.render.include_segment_ids` | bool | No | `true` |
|
| `pipeline.render.include_segment_ids` | bool | No | `true` |
|
||||||
| `pipeline.render.include_metadata` | bool | No | `false` |
|
| `pipeline.render.include_metadata` | bool | No | `false` |
|
||||||
| `pipeline.scriptorium.binary` | string | No | `scriptorium` |
|
| `pipeline.scriptorium.binary` | string | No | `scriptorium` |
|
||||||
|
| `pipeline.scriptorium.credentials[]` | list[secret reference] | No | empty; exact environment-variable names forwarded to Scriptorium |
|
||||||
| `pipeline.scriptorium.config_path` | string | No | empty |
|
| `pipeline.scriptorium.config_path` | string | No | empty |
|
||||||
| `pipeline.scriptorium.timeout` | duration | No | `10m` |
|
| `pipeline.scriptorium.timeout` | duration | No | `10m` |
|
||||||
| `pipeline.scriptorium.render_debug` | bool | No | `false` |
|
| `pipeline.scriptorium.render_debug` | bool | No | `false` |
|
||||||
@@ -407,22 +428,33 @@ or `[]` forwards nothing. A Narratio overlay replaces the entire list, and
|
|||||||
`[]` clears it. See the [Audita integration contract](./integrations/audita.md)
|
`[]` clears it. See the [Audita integration contract](./integrations/audita.md)
|
||||||
for the subprocess and redaction boundary.
|
for the subprocess and redaction boundary.
|
||||||
|
|
||||||
### Notarius Configuration Profile
|
<a id="notarius-configuration-profile"></a>
|
||||||
|
|
||||||
`pipeline.notarius.config_profile` optionally selects a Notarius ConfigKit
|
### Notarius Configuration Overlay
|
||||||
configuration profile when extraction executes:
|
|
||||||
|
Migration: rename `pipeline.notarius.config_profile` to `config_overlay`.
|
||||||
|
The old field is rejected; there is no compatibility alias. For Notarius v0.8+
|
||||||
|
move selected downstream files from `profiles/` to `overlays/` beside its root
|
||||||
|
configuration. This does not rename PromptKit LLM profiles.
|
||||||
|
The renamed selector also changes extraction resume evidence for named
|
||||||
|
selections: their existing extraction is regenerated on the next applicable
|
||||||
|
run, with normal dependent invalidation. Omitted/base selections do not acquire
|
||||||
|
a new invalidation solely from this rename.
|
||||||
|
|
||||||
|
`pipeline.notarius.config_overlay` optionally selects a Notarius ConfigKit
|
||||||
|
configuration overlay when extraction executes:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
notarius:
|
notarius:
|
||||||
config_profile: downstream-economy
|
config_overlay: downstream-economy
|
||||||
```
|
```
|
||||||
|
|
||||||
When the field is omitted or `null`, Narratio supplies no downstream profile
|
When the field is omitted or `null`, Narratio supplies no downstream overlay
|
||||||
selector and preserves Notarius's existing configuration-selection behavior.
|
selector and preserves Notarius's existing configuration-selection behavior.
|
||||||
When present, Narratio forwards the exact string to Notarius, including an
|
When present, Narratio forwards the exact string to Notarius, including an
|
||||||
empty string or `default`, which explicitly select Notarius's composed base
|
empty string or `default`, which explicitly select Notarius's composed base
|
||||||
configuration. Notarius owns selector interpretation and validation; Narratio
|
configuration. Notarius owns selector interpretation and validation; Narratio
|
||||||
does not restrict profile names, resolve profile files, or rewrite the value.
|
does not restrict overlay names, resolve overlay files, or rewrite the value.
|
||||||
|
|
||||||
This selection is independent of Narratio's own `--overlay` selection. A
|
This selection is independent of Narratio's own `--overlay` selection. A
|
||||||
Narratio overlay may explicitly select a differently named Notarius overlay,
|
Narratio overlay may explicitly select a differently named Notarius overlay,
|
||||||
@@ -533,6 +565,25 @@ contract-incompatible lane fails extraction. See the
|
|||||||
current ten-lane D&D mapping and the [Notarius contract](./integrations/notarius.md)
|
current ten-lane D&D mapping and the [Notarius contract](./integrations/notarius.md)
|
||||||
for compatibility ownership.
|
for compatibility ownership.
|
||||||
|
|
||||||
|
### Scriptorium Credentials
|
||||||
|
|
||||||
|
Set `scriptorium.credentials: [OPENROUTER_API_KEY]` in the pipeline file to
|
||||||
|
forward that provider key to Scriptorium. List additional provider names only
|
||||||
|
when the selected downstream configuration needs them. The same list applies
|
||||||
|
to trim bounds generation, analysis (including character families), and their
|
||||||
|
render-debug calls. Scriptorium retains provider/profile selection; Narratio
|
||||||
|
does not pass a model-request `--api-key-env` override.
|
||||||
|
|
||||||
|
As with Audita and Notarius, names are ConfigKit secret references resolved at
|
||||||
|
pipeline load time using the existing environment/secrets bootstrap precedence,
|
||||||
|
even when no Scriptorium stage executes. Omitted, null, or empty lists forward
|
||||||
|
nothing. An overlay replaces the entire list; `[]` clears it. Captured values
|
||||||
|
are forwarded under their exact names and registered for diagnostic redaction.
|
||||||
|
Inspection and generated metadata contain names only. Credential changes do
|
||||||
|
not invalidate completed trim or analysis work; rotating values also leaves
|
||||||
|
the effective configuration digest unchanged. Other environment variables
|
||||||
|
retain the shared minimal subprocess inheritance rules.
|
||||||
|
|
||||||
### Scriptorium Artifact Entries
|
### Scriptorium Artifact Entries
|
||||||
|
|
||||||
For each `pipeline.scriptorium.artifacts.<name>`:
|
For each `pipeline.scriptorium.artifacts.<name>`:
|
||||||
@@ -598,7 +649,11 @@ For each `pipeline.scriptorium.artifact_families.<name>`:
|
|||||||
| `output_path_pattern` | string | Yes | safe path beneath `artifacts/` with exactly one `{character_id}` token and no other brace syntax |
|
| `output_path_pattern` | string | Yes | safe path beneath `artifacts/` with exactly one `{character_id}` token and no other brace syntax |
|
||||||
| `member_vars` | map | No | maps an ordinary Scriptorium variable name to a supported canonical character selector |
|
| `member_vars` | map | No | maps an ordinary Scriptorium variable name to a supported canonical character selector |
|
||||||
| `member_dependencies` | list | No | unique family keys; each generated member depends on the corresponding generated member of each listed family |
|
| `member_dependencies` | list | No | unique family keys; each generated member depends on the corresponding generated member of each listed family |
|
||||||
| `publish` | map | No | typed family publish policy (`enabled`, `required`, `dest_pattern`) expanded into concrete publish outputs when enabled |
|
| `publish` | map | No | typed family publish policy (`enabled`, `required`, `dest_pattern`) validated against effective `pipeline.publish` settings and expanded into concrete publish outputs when enabled |
|
||||||
|
|
||||||
|
An enabled family publish declaration is validated against the effective
|
||||||
|
`pipeline.publish` configuration, including its defaults; it does not require
|
||||||
|
an explicit `publish.enabled` declaration in the same source file.
|
||||||
|
|
||||||
Generated keys are `<family>_<character_id>` and generated output paths must
|
Generated keys are `<family>_<character_id>` and generated output paths must
|
||||||
not collide with explicit artifacts or another generated artifact. Families
|
not collide with explicit artifacts or another generated artifact. Families
|
||||||
@@ -636,7 +691,7 @@ integration.
|
|||||||
| `inputs.speakers_file` | string | Yes | stable input default |
|
| `inputs.speakers_file` | string | Yes | stable input default |
|
||||||
| `inputs.autocorrect_file` | string | Yes | stable input default |
|
| `inputs.autocorrect_file` | string | Yes | stable input default |
|
||||||
| `inputs.glossary_file` | string | Yes | stable input default |
|
| `inputs.glossary_file` | string | Yes | stable input default |
|
||||||
| `inputs.party_file` | string | Yes | stable campaign party source; relative paths resolve from `campaign.yml` |
|
| `inputs.party_file` | string | Yes | stable campaign party source; relative paths resolve from their defining source |
|
||||||
| `inputs.spell_catalog_file` | string | No | optional spell-catalog overlay default; required when a Notarius reference selects `narratio.input.spell_catalog` |
|
| `inputs.spell_catalog_file` | string | No | optional spell-catalog overlay default; required when a Notarius reference selects `narratio.input.spell_catalog` |
|
||||||
|
|
||||||
### Session
|
### Session
|
||||||
|
|||||||
@@ -16,8 +16,32 @@ commit-after-completed-work rule; it does not authorize pushing or releasing.
|
|||||||
|
|
||||||
## Go Prerequisite
|
## Go Prerequisite
|
||||||
|
|
||||||
Maintained development and verification require Go 1.26. Use the official Go
|
The Go consumer minimum is 1.27.0, declared in `go.mod`. Maintained development
|
||||||
1.26 toolchain before running repository commands.
|
and verification use the official Go 1.27.4 toolchain. Release validation and
|
||||||
|
builds use the selected patch version and setup instructions in the
|
||||||
|
[release procedure](release.md#release-toolchain).
|
||||||
|
|
||||||
|
## Policy Reading Guide
|
||||||
|
|
||||||
|
| Policy | Read before… |
|
||||||
|
| --- | --- |
|
||||||
|
| [Policy set provenance](policy/meta.md) | Adopting policies, checking upstream revisions, or updating the adopted policy set. |
|
||||||
|
| [Agents](policy/agents.md) | Recommending, planning, or implementing repository changes. |
|
||||||
|
| [Architecture](policy/architecture.md) | Planning or changing application code or its structure. |
|
||||||
|
| [Testing](policy/testing.md) | Selecting validation for code changes, or adding, changing, removing, or evaluating tests. |
|
||||||
|
| [Documentation](policy/documentation.md) | Writing, revising, or reorganizing documentation. |
|
||||||
|
| [OSS](policy/oss.md) | Adding or updating dependencies or incorporated third-party material, or changing licensing or attribution. |
|
||||||
|
| [Release](policy/release.md) | Preparing or publishing a release, changing release procedures, or making versioning and compatibility decisions. |
|
||||||
|
|
||||||
|
- Read applicable policies before making decisions they govern; multiple policies
|
||||||
|
may apply.
|
||||||
|
- Select policies using the task triggers above. Follow cross-references to
|
||||||
|
relevant sections when needed to resolve a concrete question.
|
||||||
|
- Reuse policies already available in context; reread when changed or no longer
|
||||||
|
available.
|
||||||
|
- Expand reading when the task's scope expands.
|
||||||
|
- When revising a policy itself, read that policy and any provisions elsewhere
|
||||||
|
affected by the revision.
|
||||||
|
|
||||||
## What To Read
|
## What To Read
|
||||||
|
|
||||||
@@ -34,7 +58,7 @@ Maintained development and verification require Go 1.26. Use the official Go
|
|||||||
| Adapters or external tool contracts | [Adapter Internals](internal/adapters.md) and [Integration Contracts](integrations/README.md) | The internal guide owns adapter composition and mechanics; integration documents own external formats and protocols. |
|
| Adapters or external tool contracts | [Adapter Internals](internal/adapters.md) and [Integration Contracts](integrations/README.md) | The internal guide owns adapter composition and mechanics; integration documents own external formats and protocols. |
|
||||||
| Manifests, artifacts, workspace paths, or publish behavior | [Manifest Internals](internal/manifest.md), [Artifact Internals](internal/artifacts.md), [Workspace Internals](internal/workspace.md), [Publish Internals](internal/stage-publish.md), and [Operations](operations.md) | These separate implementation state and resolution from operator-visible layout and lifecycle. |
|
| Manifests, artifacts, workspace paths, or publish behavior | [Manifest Internals](internal/manifest.md), [Artifact Internals](internal/artifacts.md), [Workspace Internals](internal/workspace.md), [Publish Internals](internal/stage-publish.md), and [Operations](operations.md) | These separate implementation state and resolution from operator-visible layout and lifecycle. |
|
||||||
| Maintained configuration or input examples | [Configuration](config.md) and [Examples](../examples/README.md) | The reference owns field meanings; the examples directory owns complete copyable files. |
|
| Maintained configuration or input examples | [Configuration](config.md) and [Examples](../examples/README.md) | The reference owns field meanings; the examples directory owns complete copyable files. |
|
||||||
| Preparing, validating, or publishing a release | [Release Policy](policy/release.md) and [Release Procedure](release.md) | Policy owns requirements and exceptions; the procedure owns concrete validation, guarded publication, and optional later inspection. |
|
| Preparing, validating, or publishing a release | [Release Policy](policy/release.md) and [Release Procedure](release.md) | Policy owns requirements; the procedure owns concrete validation, guarded publication, and optional later inspection. |
|
||||||
| Proposed or unimplemented behavior | `docs/roadmap/` | Future work belongs only in roadmap documentation until implemented. |
|
| Proposed or unimplemented behavior | `docs/roadmap/` | Future work belongs only in roadmap documentation until implemented. |
|
||||||
|
|
||||||
For an existing subsystem, also inspect its focused tests and package-level
|
For an existing subsystem, also inspect its focused tests and package-level
|
||||||
@@ -42,23 +66,25 @@ contracts before changing behavior.
|
|||||||
|
|
||||||
## Validation
|
## Validation
|
||||||
|
|
||||||
Use focused package tests while iterating. Every pull request and push runs the
|
Use focused package tests while iterating. Push and pull-request CI runs these
|
||||||
following repository-wide checks before it can be accepted:
|
repository-wide checks and cross-builds the declared targets:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
go test ./...
|
go test ./...
|
||||||
go test -race ./...
|
go test -race ./...
|
||||||
go vet ./...
|
go vet ./...
|
||||||
go build ./...
|
go build ./...
|
||||||
go test ./internal/doccheck
|
|
||||||
go test ./internal/config -run '^TestExamplesLoadAndValidate$'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The documentation check verifies local Markdown links and the dependency graph
|
The full suite includes documentation-link and Woodpecker dependency checks
|
||||||
of the Woodpecker workflows. The configuration check loads every maintained
|
and loads maintained pipeline and session examples. For focused diagnosis,
|
||||||
pipeline and session example. Tag CI reuses this validation path before its
|
run `go test ./internal/doccheck` or
|
||||||
asynchronous asset publication; the maintainer release boundary is documented
|
`go test ./internal/config -run '^TestExamplesLoadAndValidate$'` directly;
|
||||||
in the [Release Procedure](release.md).
|
these are available developer tools, not additional CI steps. Tag CI
|
||||||
|
independently revalidates the tagged source before asynchronous asset delivery;
|
||||||
|
it is not a second synchronous release prerequisite. The normal maintainer
|
||||||
|
entry point is the single publication command in the
|
||||||
|
[Release Procedure](release.md).
|
||||||
|
|
||||||
Woodpecker also runs `go test -race -shuffle=on -count=3 ./...` on its scheduled
|
Woodpecker also runs `go test -race -shuffle=on -count=3 ./...` on its scheduled
|
||||||
job to expose ordering and repeatability defects. Current runners cross-compile
|
job to expose ordering and repeatability defects. Current runners cross-compile
|
||||||
|
|||||||
@@ -7,14 +7,14 @@ lanes from the final trimmed Seriatim transcript. Narratio owns invocation,
|
|||||||
safe bundle discovery, lane selection, and its own artifact metadata. Notarius
|
safe bundle discovery, lane selection, and its own artifact metadata. Notarius
|
||||||
owns pipeline definitions, lane schemas, the receipt, and bundle formats.
|
owns pipeline definitions, lane schemas, the receipt, and bundle formats.
|
||||||
|
|
||||||
Canonical Notarius v0.7.0 references:
|
Canonical Notarius v0.8.1 references:
|
||||||
|
|
||||||
- [CLI reference](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/cli.md)
|
- [CLI reference](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/cli.md)
|
||||||
- [Subprocess consumer contract](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/consumers/subprocess.md)
|
- [Subprocess consumer contract](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/consumers/subprocess.md)
|
||||||
- [D&D pipeline and lane contracts](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/consumers/dnd-pipeline.md)
|
- [D&D pipeline and lane contracts](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/consumers/dnd-pipeline.md)
|
||||||
- [Run-result receipt](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/integrations/run-result.md)
|
- [Run-result receipt](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/integrations/run-result.md)
|
||||||
- [JSON output bundle](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/integrations/json-output.md)
|
- [JSON output bundle](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/integrations/json-output.md)
|
||||||
- [D&D spell-catalog overlay](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/integrations/dnd-spell-catalog-overlays.md)
|
- [D&D spell-catalog overlay](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/integrations/dnd-spell-catalog-overlays.md)
|
||||||
|
|
||||||
The [complete Narratio example](../../examples/pipeline.full.annotated.yml)
|
The [complete Narratio example](../../examples/pipeline.full.annotated.yml)
|
||||||
records the exact current constraints for all ten D&D lanes. Treat the linked
|
records the exact current constraints for all ten D&D lanes. Treat the linked
|
||||||
@@ -27,17 +27,17 @@ When `pipeline.notarius.enabled` is true, Narratio resolves the executable,
|
|||||||
configuration path, input path, output directory, and working directory to
|
configuration path, input path, output directory, and working directory to
|
||||||
absolute paths. Configured references require support for the `--reference`
|
absolute paths. Configured references require support for the `--reference`
|
||||||
contract introduced in Notarius v0.6.0. Cache controls require support for the
|
contract introduced in Notarius v0.6.0. Cache controls require support for the
|
||||||
selected `--resume` and `--chunk_cache` flags. Notarius v0.7.0 is the tested
|
selected `--resume` and `--chunk_cache` flags. Notarius v0.8.1 is the tested
|
||||||
cache integration baseline, not an unconditional minimum version; Narratio
|
cache integration baseline, not an unconditional minimum version; Narratio
|
||||||
does not impose a runtime version gate. Each reference binding is a separate
|
does not impose a runtime version gate. Each reference binding is a separate
|
||||||
argument before `--json`. When `pipeline.notarius.config_profile` is present,
|
argument before `--json`. When `pipeline.notarius.config_overlay` is present,
|
||||||
its exact value is another argument pair before `--json`:
|
its exact value is another argument pair before `--json`:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
notarius run <pipeline_id> --config <config_path> --input <trimmed_json> --output-dir <staging_dir> [--resume] [--chunk_cache <mode>] [--reference <selector>=<verified_snapshot_path>]... [--config-profile <name>] --json
|
notarius run <pipeline_id> --config <config_path> --input <trimmed_json> --output-dir <staging_dir> [--resume] [--chunk_cache <mode>] [--reference <selector>=<verified_snapshot_path>]... [--config-overlay <name>] --json
|
||||||
```
|
```
|
||||||
|
|
||||||
Notarius v0.7.0 is a known supporting version for `--config-profile`; using the
|
Notarius v0.8.1 is a known supporting version for `--config-overlay`; using the
|
||||||
option requires a compatible Notarius executable, but deployments that omit the
|
option requires a compatible Notarius executable, but deployments that omit the
|
||||||
field acquire no additional version requirement. Omitted or null configuration
|
field acquire no additional version requirement. Omitted or null configuration
|
||||||
adds no flag. Supplied empty, `default`, and named selectors are forwarded
|
adds no flag. Supplied empty, `default`, and named selectors are forwarded
|
||||||
@@ -46,7 +46,7 @@ option selects a Notarius configuration overlay, not a PromptKit profile through
|
|||||||
`--llm-profile`, and Narratio never substitutes its own selected overlay name.
|
`--llm-profile`, and Narratio never substitutes its own selected overlay name.
|
||||||
A missing or invalid downstream overlay is an ordinary Notarius subprocess
|
A missing or invalid downstream overlay is an ordinary Notarius subprocess
|
||||||
failure: Narratio does not retry without the selector or fall back to another
|
failure: Narratio does not retry without the selector or fall back to another
|
||||||
profile.
|
overlay.
|
||||||
|
|
||||||
Reference paths are absolute stable snapshots streamed from manifest-verified
|
Reference paths are absolute stable snapshots streamed from manifest-verified
|
||||||
canonical files prepared inside the current Narratio session workspace. They
|
canonical files prepared inside the current Narratio session workspace. They
|
||||||
@@ -129,7 +129,7 @@ encoded credentials.
|
|||||||
|
|
||||||
## Accepted Result
|
## Accepted Result
|
||||||
|
|
||||||
Narratio's tested invocation baseline is Notarius v0.7.0. The accepted
|
Narratio's tested invocation baseline is Notarius v0.8.1. The accepted
|
||||||
receipt remains `notarius.run-result.v2`; reference flags do not change the
|
receipt remains `notarius.run-result.v2`; reference flags do not change the
|
||||||
receipt or ten-lane output contract. The receipt
|
receipt or ten-lane output contract. The receipt
|
||||||
must identify the configured pipeline, and its `index_file` must be exactly
|
must identify the configured pipeline, and its `index_file` must be exactly
|
||||||
@@ -188,7 +188,7 @@ for failure recovery.
|
|||||||
## Opt-in Integration Test
|
## Opt-in Integration Test
|
||||||
|
|
||||||
The production-boundary cache test requires an absolute path to a locally
|
The production-boundary cache test requires an absolute path to a locally
|
||||||
built Notarius v0.7.0-compatible executable. It uses only a local
|
built Notarius v0.8.1-compatible executable. It uses only a local
|
||||||
OpenAI-compatible `httptest` provider and temporary cache/config/output roots:
|
OpenAI-compatible `httptest` provider and temporary cache/config/output roots:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Canonical Party Input
|
# Canonical Party Input
|
||||||
|
|
||||||
`party.yml` is a campaign-owned roster input. It must be a single, versioned
|
`party.yml` is a campaign-owned roster input. Its main document must declare
|
||||||
`narratio.party.v1` document when Narratio resolves a pipeline, campaign, and
|
`narratio.party.v1` when Narratio resolves the roster. Local party files may
|
||||||
session together.
|
import fragments; fragments need no version header.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
schema_version: narratio.party.v1
|
schema_version: narratio.party.v1
|
||||||
@@ -48,8 +48,8 @@ The configuration rules and source-relative path behavior are defined in the
|
|||||||
|
|
||||||
## Derived players document
|
## Derived players document
|
||||||
|
|
||||||
During `prepare`, Narratio copies the canonical party source bytes unchanged
|
During `prepare`, Narratio renders the effective roster as standalone canonical
|
||||||
to `inputs/party.yml` and writes this deterministic players-only projection to
|
`inputs/party.yml` and writes this deterministic players-only projection to
|
||||||
`inputs/players.yml`:
|
`inputs/players.yml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Both request types carry:
|
|||||||
- output path;
|
- output path;
|
||||||
- timeout;
|
- timeout;
|
||||||
- generated config + stdout/stderr log paths;
|
- generated config + stdout/stderr log paths;
|
||||||
- optional API-key env var name;
|
- optional list of already-resolved credential references;
|
||||||
- optional working directory.
|
- optional working directory.
|
||||||
|
|
||||||
## Result Contract
|
## Result Contract
|
||||||
@@ -39,7 +39,16 @@ Request validation fails for:
|
|||||||
- non-positive timeout;
|
- non-positive timeout;
|
||||||
- empty input/var names;
|
- empty input/var names;
|
||||||
- empty input path values;
|
- empty input path values;
|
||||||
- missing required credential env var when `APIKeyEnv` is set.
|
- unresolved or empty selected credential references.
|
||||||
|
|
||||||
|
Both modes use the shared credential forwarding used by Audita and Notarius:
|
||||||
|
selected names and captured values augment the minimal child environment, and
|
||||||
|
all selected values are registered for captured-stream redaction. The adapter
|
||||||
|
does not reread the parent environment or override Scriptorium's provider
|
||||||
|
selection with `--api-key-env`. Generated invocation records and result metadata
|
||||||
|
contain `credential_env_names`, never credential values. This does not scan or
|
||||||
|
redact files written directly by Scriptorium. Selection semantics belong in
|
||||||
|
[Scriptorium credentials](../config.md#scriptorium-credentials).
|
||||||
|
|
||||||
Run behavior:
|
Run behavior:
|
||||||
- subprocess errors propagate with context;
|
- subprocess errors propagate with context;
|
||||||
|
|||||||
@@ -69,13 +69,13 @@ It also serializes an effective resume request as `--resume` and a nonempty
|
|||||||
validated chunk mode as `--chunk_cache <mode>`. The extract stage, not the
|
validated chunk mode as `--chunk_cache <mode>`. The extract stage, not the
|
||||||
adapter, resolves force precedence before constructing the request.
|
adapter, resolves force precedence before constructing the request.
|
||||||
Its request may also carry already-resolved ConfigKit secret references.
|
Its request may also carry already-resolved ConfigKit secret references.
|
||||||
Audita's request carries the same kind of list. Both adapters use the shared
|
Audita and Scriptorium requests carry the same kind of list. All three adapters use the shared
|
||||||
subprocess helper to convert their selected references into exact-name child
|
subprocess helper to convert their selected references into exact-name child
|
||||||
environment overrides and sensitive-name registration. That helper rejects
|
environment overrides and sensitive-name registration. That helper rejects
|
||||||
unresolved or empty programmatic references, but neither adapter rereads the
|
unresolved or empty programmatic references, but no adapter rereads the
|
||||||
parent environment or inspects downstream configuration to discover names.
|
parent environment or inspects downstream configuration to discover names.
|
||||||
Empty lists add no credential overrides. See the public [Audita](../integrations/audita.md)
|
Empty lists add no credential overrides. See the public [Audita](../integrations/audita.md)
|
||||||
and [Notarius](../integrations/notarius.md) contracts for selection and
|
[Notarius](../integrations/notarius.md), and [Scriptorium](../integrations/scriptorium.md) contracts for selection and
|
||||||
downstream-file boundaries.
|
downstream-file boundaries.
|
||||||
|
|
||||||
Application-owned object-store construction loads configured filesystem
|
Application-owned object-store construction loads configured filesystem
|
||||||
|
|||||||
@@ -37,6 +37,8 @@ Restore planner action kinds:
|
|||||||
|
|
||||||
Planner behavior:
|
Planner behavior:
|
||||||
|
|
||||||
|
- prepared campaign, session, and party inputs are restored from their declared
|
||||||
|
immutable run objects to their canonical local input paths;
|
||||||
- a new-protocol restore uses only the selected commit's declared artifact set;
|
- a new-protocol restore uses only the selected commit's declared artifact set;
|
||||||
each action carries that artifact's immutable key, checksum, size, and
|
each action carries that artifact's immutable key, checksum, size, and
|
||||||
generation;
|
generation;
|
||||||
|
|||||||
@@ -1,196 +1,81 @@
|
|||||||
# Configuration Internals
|
# Configuration Internals
|
||||||
|
|
||||||
User-visible fields, defaults, and selection behavior belong in the
|
User-visible fields, defaults, discovery, and selection belong in the
|
||||||
[Configuration Reference](../config.md). This document describes the internal
|
[Configuration Reference](../config.md). This document describes the
|
||||||
pipeline-loading boundary implemented by `internal/config`.
|
`internal/config` loading and resolution boundary.
|
||||||
|
|
||||||
## Pipeline Loading
|
## Pipeline Loading
|
||||||
|
|
||||||
`LoadPipeline` assembles and validates a pipeline in this order:
|
Commands bootstrap secrets once before loading, then select an explicit file or
|
||||||
|
native required discovery. ConfigKit loads typed defaults, source-root imports,
|
||||||
|
and the selected overlay, resolves inheritance, and strictly decodes the
|
||||||
|
result. Narratio applies recorded defaults, normalization, resource resolution,
|
||||||
|
and effective-domain validation. The selected root, source contexts, metadata,
|
||||||
|
and authoring result are retained for provenance. Family expansion and checks
|
||||||
|
requiring the campaign occur after campaign and party resolution.
|
||||||
|
|
||||||
1. Give ConfigKit a fresh typed `PipelineConfig` default value, the root file,
|
Resource resolution consults native entry origins and source contexts before
|
||||||
enabled imports, and the caller's overlay selection. Omitted, empty, and
|
normalization. An effective source supplies the base when usable; otherwise the
|
||||||
exact `default` selections use the base; named overlays use the fixed
|
main source, then the captured invocation directory, is the fallback. Explicit
|
||||||
`overlays/<name>.yml` convention.
|
CLI file references use the invocation directory. Derived values record their
|
||||||
2. ConfigKit parses the root and declared imports, additively merges base
|
dependencies. See the [configuration reference](../config.md#pipeline-imports-and-overlays)
|
||||||
sources, applies only the selected overlay, and strictly decodes the result.
|
for the resource classifications and native authoring contract.
|
||||||
3. The definition resolver applies recorded entry-level and inherited defaults,
|
|
||||||
runs deterministic domain normalization, records derived publish destinations,
|
|
||||||
and resolves ordinary paths relative to the root pipeline file.
|
|
||||||
4. The definition validator performs read-only checks that require only the
|
|
||||||
pipeline file. Checks requiring canonical-party family expansion remain at
|
|
||||||
the existing explicit pipeline/campaign resolution boundary.
|
|
||||||
5. Narratio inspects public ConfigKit metadata to reject artifact and family keys
|
|
||||||
declared by multiple base files, adapts source ownership records, attaches
|
|
||||||
runtime-only state, and computes the normalized effective digest.
|
|
||||||
|
|
||||||
This ordering preserves monolithic configuration behavior. Moving a field to
|
|
||||||
an imported fragment changes its source ownership, not its path base, default,
|
|
||||||
or schema semantics.
|
|
||||||
|
|
||||||
## Loaded Context Resolution
|
## Loaded Context Resolution
|
||||||
|
|
||||||
`LoadedPipelineCampaign` carries one already composed pipeline and its selected
|
`LoadedPipelineCampaign` carries the selected pipeline and campaign into local
|
||||||
campaign into session resolution. `LoadSessionWithPipelineCampaignOptions`
|
or remote session resolution. Local campaign, session, and party loads enable
|
||||||
loads a local session against that context, while
|
imports through their own ConfigKit definitions; only the pipeline selects an
|
||||||
`ResolveLoadedPipelineCampaign` also accepts an already loaded remote session
|
overlay. Native optional search distinguishes an absent local session from an
|
||||||
or no session while a caller retrieves one. Compatibility loaders route through
|
invalid selected file. Remote session bytes have no incidental download-directory
|
||||||
these functions after their initial pipeline and campaign reads.
|
context, and retain object provenance. Effective session strings are checked for
|
||||||
|
unresolved template tokens, and campaign/session identity and stable-input rules
|
||||||
|
remain Narratio-owned.
|
||||||
|
|
||||||
Application commands own pipeline and campaign discovery, campaign-file versus
|
Campaign and session loaders retain detached document values after their own
|
||||||
registry selection, and the corresponding mutual-exclusion rules. Once they
|
resolution. The session document is captured before campaign defaults are copied
|
||||||
have a `LoadedPipelineCampaign`, local session discovery and remote-session
|
into runtime session state. Configuration-owned renderers produce standalone
|
||||||
download retain that exact pipeline object and its private provenance. Removing
|
campaign and session YAML, preserving omitted session overrides. Prepare uses
|
||||||
a temporary downloaded session file therefore cannot invalidate the resolved
|
those renderers and canonical party rendering for materialization and resume
|
||||||
pipeline or campaign context.
|
comparison.
|
||||||
|
|
||||||
Campaign and session files use independent ConfigKit definitions with imports
|
## Inspection And Provenance
|
||||||
and overlays disabled. Campaign files normally load directly from their source;
|
|
||||||
session files are first read through the 8 MiB bounded-read boundary because the
|
|
||||||
application must reject unresolved template placeholders before passing an exact
|
|
||||||
byte snapshot to ConfigKit. Local and remotely downloaded session bytes then use
|
|
||||||
the same typed loader and retain the existing post-load identity expectations,
|
|
||||||
stable-input precedence, and source-relative path semantics.
|
|
||||||
|
|
||||||
The application also has a separate read-only inspection resolver for `config
|
Read-only inspection shares production pipeline and campaign selection without
|
||||||
validate`, `config show`, `config sources`, and `config artifacts`. It uses the
|
session discovery, workspace initialization, adapters, or manifest access. After
|
||||||
same production root, overlay, and campaign selection functions, but never routes
|
applicable campaign and family resolution, a safe typed final-domain DTO contains
|
||||||
through session discovery,
|
concrete artifacts and generated publish rules. It stores credential reference
|
||||||
remote-session download, adapter composition, workspace
|
names rather than typed secrets. A defaults-backed native result freezes this
|
||||||
initialization, manifest access, or cleanup. A pipeline with retained artifact
|
DTO without resolving credentials again; `WriteEffective` supplies show and
|
||||||
family declarations must resolve its selected campaign before ordinary pipeline
|
prepared pipeline YAML, and deterministic JSON of the same DTO supplies the
|
||||||
validation, which expands its canonical-party members and generated publish
|
versioned semantic digest. Resolved resources participate in that digest, while
|
||||||
rules. A pipeline without those declarations may be validated by itself.
|
source layout and secret values do not.
|
||||||
Secret-directory bootstrap remains invocation-scoped and happens before the
|
|
||||||
ordinary ConfigKit load because explicit typed references must resolve even for
|
|
||||||
inspection.
|
|
||||||
|
|
||||||
`MarshalEffectivePipeline` is the configuration-owned projection for `config
|
Authoring results separately supply native origins, source histories, and empty
|
||||||
show`. It serializes one explicit typed safe projection with the existing YAML
|
optional-import evidence to source and artifact inspection. Family and party
|
||||||
encoder. The projection has no slots for resolution-only artifact family
|
context identifies generated entries without reparsing sources. Diff fully
|
||||||
declarations or private provenance. The result has one trailing newline;
|
resolves each side against the same selected campaign and party, then uses
|
||||||
commands do not marshal runtime objects directly.
|
ConfigKit `Diff` on the safe snapshots. The command presents native JSON Pointer
|
||||||
|
paths and safe compact values.
|
||||||
`EffectivePipelineSources` and `EffectiveCampaignSources` provide the separate
|
|
||||||
safe provenance projection for `config sources`. Pipeline ownership begins with
|
|
||||||
the complete logical field paths projected from the schema and classifies
|
|
||||||
each contributor as root, import, overlay, or centralized default. The
|
|
||||||
projection replaces generated concrete member paths with paired family and
|
|
||||||
canonical-party records, and does the same for generated publish rules.
|
|
||||||
Campaign records identify campaign-owned fields and party inputs; canonical
|
|
||||||
derived players point to the party source. The application command only joins these sorted
|
|
||||||
records with selection metadata and never reparses configuration files.
|
|
||||||
|
|
||||||
`EffectiveArtifactCatalog` projects the same finalized concrete artifact map for
|
|
||||||
`config artifacts`. It derives source identity from each map key, carries sorted
|
|
||||||
effective dependencies, aggregates ConfigKit definition contributors, and adds
|
|
||||||
family/character/party provenance for generated members. It does not inspect
|
|
||||||
files named after artifacts or infer another runtime graph.
|
|
||||||
|
|
||||||
`config diff` uses a thin paired loader that performs two independent ConfigKit
|
|
||||||
loads. When campaign
|
|
||||||
resolution is needed, the command loads one selected campaign and party and
|
|
||||||
expands both effective pipelines from that same party value. The configuration
|
|
||||||
owner projects each normalized effective mapping directly from that same typed
|
|
||||||
projection into sorted logical paths using JSON number preservation;
|
|
||||||
mapping leaves are compared individually while sequence values remain atomic.
|
|
||||||
Values are compact deterministic JSON representations for command output, not
|
|
||||||
raw YAML fragments, ownership records, or secret material. A differing digest
|
|
||||||
with no projected difference is treated as an internal consistency error.
|
|
||||||
|
|
||||||
Campaign context construction reads the campaign-owned party source through
|
|
||||||
`ParseParty`. The required canonical party retains its raw bytes and normalized
|
|
||||||
roster in runtime-only `ResolvedParty` provenance. Canonical resolution creates
|
|
||||||
a deterministic `derived_from_party` players projection. The party is the only
|
|
||||||
configured roster authority; player and session-party fields are unsupported.
|
|
||||||
|
|
||||||
## Canonical Party Domain
|
## Canonical Party Domain
|
||||||
|
|
||||||
`ParseParty` is the package-owned boundary for parsing a party source. Its
|
File-backed party loading enables imports; `ParseParty` accepts contextless bytes.
|
||||||
single-source ConfigKit definition disables imports and overlays, requires
|
The shared definition checks the main document's version and Narratio validates
|
||||||
`schema_version` through `VersionRule`, and strictly decodes the
|
the effective character roster. Native acquisition order and source coordinates
|
||||||
character-keyed typed schema before applying Narratio's party-domain checks.
|
establish roster order, favoring each child's own declaration. A deterministic
|
||||||
Successful metadata coordinates recover authored character-map order without a
|
renderer writes standalone canonical party YAML from that roster; the players
|
||||||
second YAML parse; class and alias slice order comes directly from typed decode.
|
projection and family expansion use the same resolved roster. The external format
|
||||||
The canonical value retains a separate exact byte copy of its source so
|
is defined in the [party contract](../integrations/party.md).
|
||||||
consumers can materialize the authored party document without reserializing it.
|
|
||||||
Its `PlayersYAML` method deterministically derives the ID-sorted, versioned
|
|
||||||
players-only projection.
|
|
||||||
|
|
||||||
An unversioned source is rejected before resolution, family expansion, or
|
|
||||||
prepare-stage materialization.
|
|
||||||
|
|
||||||
## Validation Ownership
|
## Validation Ownership
|
||||||
|
|
||||||
Configuration validation remains within `internal/config`, with the public
|
ConfigKit owns composition, inheritance, presence, typed-secret resolution, and
|
||||||
entry points and pipeline-domain sequencing separated from the private owners
|
provenance. Narratio owns validation and normalization of effective domain
|
||||||
for core pipeline/session rules, external adapters, publish/storage, Notarius,
|
values. Source histories are inspection evidence, not an additional acceptance
|
||||||
Scriptorium, and shared scalar/path checks. These are package-local ownership
|
gate. Focused configuration and application tests exercise imports, resource
|
||||||
boundaries rather than extension points or a general validation framework.
|
contexts, snapshots, secret-safe inspection, party resolution, and materialized
|
||||||
|
inputs through the production boundaries.
|
||||||
Validation is read-only, fails fast, and does not define which of several
|
|
||||||
independent invalid fields is reported first. Map-backed declarations are
|
|
||||||
nevertheless traversed deterministically. Reusable domain normalization is an
|
|
||||||
explicit preceding operation for both loaded and programmatically constructed
|
|
||||||
pipelines. Notarius normalization commits canonical scalar, reference, and output
|
|
||||||
values only after the complete normalization succeeds; its validator then checks
|
|
||||||
that candidate without changing it. Scriptorium validates artifact declarations
|
|
||||||
and outputs, dependencies and inputs, variables, referenced outputs, and the final
|
|
||||||
dependency graph in deterministic artifact order.
|
|
||||||
|
|
||||||
Diagnostics identify the relevant semantic field. Merge conflicts also
|
|
||||||
retain every claiming source needed to correct an additive ownership conflict.
|
|
||||||
Complete prose, punctuation, formatting, and private validation choreography are
|
|
||||||
not compatibility contracts.
|
|
||||||
|
|
||||||
## Diagnostics And Runtime Metadata
|
|
||||||
|
|
||||||
Syntax, duplicate-key, merge, overlay, and schema failures include the
|
|
||||||
relevant source name and full field path. Additive conflicts report every
|
|
||||||
claiming source so operators can repair the split without repeatedly
|
|
||||||
rediscovering additional conflicts.
|
|
||||||
|
|
||||||
The loaded pipeline retains private runtime metadata for the absolute root
|
|
||||||
path, ordered imports, selected overlay name, source, and path, original
|
|
||||||
ConfigKit metadata and source snapshots, effective digest,
|
|
||||||
and leaf ownership. Base
|
|
||||||
leaves retain their root/import owners, replaced leaves belong to the selected
|
|
||||||
overlay, and centrally supplied values use the synthetic `default` owner. This
|
|
||||||
metadata does not participate in YAML decoding or alter the public
|
|
||||||
configuration model.
|
|
||||||
|
|
||||||
The effective digest is SHA-256 over a versioned deterministic JSON encoding of
|
|
||||||
the same typed safe projection used by show and diff. Runtime Notarius paths remain absolute for
|
|
||||||
execution, but the digest substitutes their normalized logical values captured
|
|
||||||
before root-relative resolution, so relocating an equivalent configuration
|
|
||||||
bundle does not change provenance. Because ConfigKit and resolution metadata
|
|
||||||
are private, the digest excludes source layout, overlay name, and ownership.
|
|
||||||
Configuration stores credentials as ConfigKit typed references. A successful
|
|
||||||
load resolves their values inside the opaque typed boundary, while this safe
|
|
||||||
projection serializes only `EnvName()` identities. Credential-value changes are
|
|
||||||
therefore never hashed; reference-name changes remain ordinary provenance.
|
|
||||||
The optional Notarius credential follows the same path even for disabled or
|
|
||||||
resumable extraction; normalization copies the opaque reference without reading
|
|
||||||
or resolving it again. Direct YAML serialization has a configuration-owned safe
|
|
||||||
projection so only the reference name can leave this boundary.
|
|
||||||
`recomputePipelineEffectiveDigest` is the single package-owned refresh point
|
|
||||||
for later runtime expansion.
|
|
||||||
|
|
||||||
## Test Surfaces
|
|
||||||
|
|
||||||
`pipeline_configkit_test.go` exercises real imports and fixed-path overlays,
|
|
||||||
base selection, unselected-overlay isolation, source attribution, and Narratio's
|
|
||||||
unique artifact/family base-declaration rule. Existing focused configuration
|
|
||||||
tests protect defaults, explicit-value semantics, strict decoding, validation,
|
|
||||||
metadata, and root-relative path behavior. Application configuration-loader tests protect the
|
|
||||||
single-read boundary by changing the pipeline file after its initial load and
|
|
||||||
confirming local session resolution retains the original pipeline. Other
|
|
||||||
configuration tests continue to protect defaults and validation after assembly.
|
|
||||||
`party_test.go` protects the versioned typed party schema, domain invariants,
|
|
||||||
authored character order, retained bytes, and deterministic players projection
|
|
||||||
without involving campaign or runtime wiring.
|
|
||||||
`party_resolution_test.go` protects campaign-owned party loading, canonical
|
|
||||||
input restrictions, source provenance, and virtual players input selection.
|
|
||||||
|
|
||||||
## Artifact Family Resolution
|
## Artifact Family Resolution
|
||||||
|
|
||||||
|
|||||||
@@ -107,7 +107,7 @@ so any earlier replacement can stale a prior cleanup result.
|
|||||||
## Focused Documentation
|
## Focused Documentation
|
||||||
|
|
||||||
- [Configuration Internals](configuration.md): pipeline imports and overlays,
|
- [Configuration Internals](configuration.md): pipeline imports and overlays,
|
||||||
field ownership, decoding, and root-relative path semantics.
|
field ownership, decoding, and source-relative resource semantics.
|
||||||
- [Adapter Internals](adapters.md): external adapter boundaries, composition,
|
- [Adapter Internals](adapters.md): external adapter boundaries, composition,
|
||||||
failure behavior, and test surfaces.
|
failure behavior, and test surfaces.
|
||||||
- [Artifact Internals](artifacts.md): source identities, runtime catalog,
|
- [Artifact Internals](artifacts.md): source identities, runtime catalog,
|
||||||
|
|||||||
@@ -24,11 +24,11 @@ procedures belong in [Operations](../operations.md).
|
|||||||
and rejects any source change observed while copying;
|
and rejects any source change observed while copying;
|
||||||
4. fingerprints the byte- and provenance-bearing Notarius invocation evidence,
|
4. fingerprints the byte- and provenance-bearing Notarius invocation evidence,
|
||||||
including sorted reference identities and the explicit downstream
|
including sorted reference identities and the explicit downstream
|
||||||
configuration-profile selection;
|
configuration-overlay selection;
|
||||||
5. creates a run-local staging directory and invokes the injected
|
5. creates a run-local staging directory and invokes the injected
|
||||||
`notarius.Runner`, carrying the optional already-resolved credential
|
`notarius.Runner`, carrying the optional already-resolved credential
|
||||||
reference without exposing its value, the optional exact configuration
|
reference without exposing its value, the optional exact configuration
|
||||||
profile, plus effective resume and chunk-cache controls after force
|
overlay, plus effective resume and chunk-cache controls after force
|
||||||
precedence;
|
precedence;
|
||||||
6. revalidates the reference snapshots, then validates the v2 successful
|
6. revalidates the reference snapshots, then validates the v2 successful
|
||||||
receipt, confined index, management documents, configured required lane
|
receipt, confined index, management documents, configured required lane
|
||||||
@@ -73,7 +73,7 @@ Before the focused validator runs, the application compares extract's versioned
|
|||||||
semantic fingerprint. It covers enablement, Notarius pipeline identity, sorted
|
semantic fingerprint. It covers enablement, Notarius pipeline identity, sorted
|
||||||
reference selector/source mappings, sorted declared output contracts, and each
|
reference selector/source mappings, sorted declared output contracts, and each
|
||||||
canonical `narratio.extraction.<key>` output identity. It also covers the
|
canonical `narratio.extraction.<key>` output identity. It also covers the
|
||||||
explicit Notarius configuration-profile selection; omitted, empty, and exact
|
explicit Notarius configuration-overlay selection; omitted, empty, and exact
|
||||||
`default` selectors share the base-selection identity. It excludes executable,
|
`default` selectors share the base-selection identity. It excludes executable,
|
||||||
timeout, working directory, config path, and private Notarius config contents.
|
timeout, working directory, config path, and private Notarius config contents.
|
||||||
Credential presence, reference name, and resolved value are likewise
|
Credential presence, reference name, and resolved value are likewise
|
||||||
@@ -85,7 +85,7 @@ not rerun a valid completed extraction or stale its dependents.
|
|||||||
stage record still matches the current byte- and provenance-bearing invocation
|
stage record still matches the current byte- and provenance-bearing invocation
|
||||||
evidence. That evidence covers the current direct trimmed-transcript identity,
|
evidence. That evidence covers the current direct trimmed-transcript identity,
|
||||||
sorted prepared-reference identities, pipeline identity, and configured output
|
sorted prepared-reference identities, pipeline identity, and configured output
|
||||||
contracts, plus the same downstream profile-selection identity. The same
|
contracts, plus the same downstream overlay-selection identity. The same
|
||||||
reference helper and transcript identity are resolved again for artifact
|
reference helper and transcript identity are resolved again for artifact
|
||||||
evidence, so changing current transcript bytes, reference bytes, producer
|
evidence, so changing current transcript bytes, reference bytes, producer
|
||||||
identity, or a named downstream selection makes the prior extraction obsolete.
|
identity, or a named downstream selection makes the prior extraction obsolete.
|
||||||
@@ -107,7 +107,7 @@ obsolete results are non-resumable and run again; unsafe filesystem conditions
|
|||||||
return an error rather than silently accepting or replacing data.
|
return an error rather than silently accepting or replacing data.
|
||||||
|
|
||||||
This sensitivity is limited to the explicit downstream selector. Narratio's
|
This sensitivity is limited to the explicit downstream selector. Narratio's
|
||||||
own profile label and whole effective-configuration digest are not blanket
|
own overlay label and whole effective-configuration digest are not blanket
|
||||||
extraction invalidators. Neither contract can observe files imported by
|
extraction invalidators. Neither contract can observe files imported by
|
||||||
Notarius configuration, profile contents, prompt/module definitions, or other
|
Notarius configuration, profile contents, prompt/module definitions, or other
|
||||||
transitive inputs. Operators must force extraction after changing any such
|
transitive inputs. Operators must force extraction after changing any such
|
||||||
@@ -144,5 +144,5 @@ recovery.
|
|||||||
`internal/artifacts/extraction_catalog_test.go`
|
`internal/artifacts/extraction_catalog_test.go`
|
||||||
- Composition and downstream behavior: `internal/app/runner_test.go`,
|
- Composition and downstream behavior: `internal/app/runner_test.go`,
|
||||||
`internal/stage/analyze_test.go`, `internal/stage/publish_test.go`
|
`internal/stage/analyze_test.go`, `internal/stage/publish_test.go`
|
||||||
- Opt-in Notarius v0.7.0 production-boundary coverage:
|
- Opt-in Notarius v0.8.1 production-boundary coverage:
|
||||||
`internal/stage/notarius_cache_integration_test.go`
|
`internal/stage/notarius_cache_integration_test.go`
|
||||||
|
|||||||
@@ -39,8 +39,8 @@ Materialize canonical current-session inputs before processing stages.
|
|||||||
- materializes a configured spell catalog with checksum and provenance, or
|
- materializes a configured spell catalog with checksum and provenance, or
|
||||||
safely removes an obsolete canonical spell catalog and its manifest record
|
safely removes an obsolete canonical spell catalog and its manifest record
|
||||||
when the effective input is omitted.
|
when the effective input is omitted.
|
||||||
- copies the validated canonical party bytes unchanged and deterministically
|
- renders standalone effective campaign, session, and canonical party documents,
|
||||||
generates the prepared players projection.
|
and deterministically generates the prepared players projection.
|
||||||
- scans enabled configured artifact inputs for `narratio.previous_session.artifact.*` requirements.
|
- scans enabled configured artifact inputs for `narratio.previous_session.artifact.*` requirements.
|
||||||
- clears managed `previous/` state on every invocation, then, when requirements exist:
|
- clears managed `previous/` state on every invocation, then, when requirements exist:
|
||||||
- resolves the pointer-selected previous source through the shared resolver;
|
- resolves the pointer-selected previous source through the shared resolver;
|
||||||
@@ -71,15 +71,15 @@ previous-artifact requirement set. A change reruns prepare and
|
|||||||
stales its fixed descendants. Existing successful records without this
|
stales its fixed descendants. Existing successful records without this
|
||||||
evidence rerun once when selected.
|
evidence rerun once when selected.
|
||||||
|
|
||||||
Workspace, spool, and cache placement and absolute source relocation are not
|
Workspace, spool, and cache placement are not semantic when logical selection,
|
||||||
semantic when logical selection, canonical names, and bytes are equivalent.
|
canonical names, and effective bytes are equivalent.
|
||||||
The fingerprint deliberately does not read or rehash large audio. Prepared
|
The fingerprint deliberately does not read or rehash large audio. Prepared
|
||||||
input checksums remain the content provenance. Before reusing success, prepare
|
input checksums remain the content provenance. Before reusing success, prepare
|
||||||
validates every durable prepared copy and compares current stable-input bytes,
|
validates every durable prepared copy and compares current stable-input bytes,
|
||||||
canonical party and derived-player bytes, local audio membership/checksums, or
|
effective campaign/session, canonical party and derived-player bytes, local audio
|
||||||
S3 key/size/entity-tag identity with that provenance. Source relocation with
|
membership/checksums, or S3 key/size/entity-tag identity with that provenance.
|
||||||
equivalent names and bytes remains reusable; changed or unavailable evidence
|
Source relocation with equivalent effective documents, names, and bytes remains
|
||||||
causes a normal prepare rerun.
|
reusable; changed or unavailable evidence causes a normal prepare rerun.
|
||||||
|
|
||||||
## Related Contracts And Tests
|
## Related Contracts And Tests
|
||||||
|
|
||||||
|
|||||||
@@ -15,8 +15,8 @@ Upload run/session outputs to object storage and atomically advance remote curre
|
|||||||
|
|
||||||
## Outputs
|
## Outputs
|
||||||
|
|
||||||
- uploaded session manifest, declared run-local diagnostics, and selected
|
- uploaded session manifest, prepared campaign/session/party inputs, declared
|
||||||
publish outputs;
|
run-local diagnostics, and selected publish outputs;
|
||||||
- uploaded durable previous-session cache files when present;
|
- uploaded durable previous-session cache files when present;
|
||||||
- immutable run-scoped commit manifest; and
|
- immutable run-scoped commit manifest; and
|
||||||
- current commit pointer, written last.
|
- current commit pointer, written last.
|
||||||
@@ -34,7 +34,10 @@ and optional rules, destination resolution, and collision inputs live in
|
|||||||
remote verification live in `publish_transfer.go`; committed-manifest,
|
remote verification live in `publish_transfer.go`; committed-manifest,
|
||||||
immutable-commit, and current-pointer encoding and writes live in
|
immutable-commit, and current-pointer encoding and writes live in
|
||||||
`publish_commit.go`. `publish_output_plan.go` owns the deterministic, I/O-free
|
`publish_commit.go`. `publish_output_plan.go` owns the deterministic, I/O-free
|
||||||
five-outcome model and its secret-free metadata projection.
|
five-outcome model and its secret-free metadata projection. Prepared input
|
||||||
|
objects are committed under the immutable run; the committed standalone session
|
||||||
|
supports remote loading when no authored session override is available. The
|
||||||
|
[configuration reference](../config.md#sessionyml) owns input selection.
|
||||||
|
|
||||||
- when publishing or run upload is disabled, completes successfully with no
|
- when publishing or run upload is disabled, completes successfully with no
|
||||||
outputs and records explanatory metadata. This is not an explicit self-skip:
|
outputs and records explanatory metadata. This is not an explicit self-skip:
|
||||||
|
|||||||
@@ -282,16 +282,68 @@ earlier checkpoints are reused and execution resumes with failed, stale, or
|
|||||||
missing work in dependency order. `--force` is unnecessary unless the operator
|
missing work in dependency order. `--force` is unnecessary unless the operator
|
||||||
intends to replace otherwise-current artifacts.
|
intends to replace otherwise-current artifacts.
|
||||||
|
|
||||||
### Developing With A Notarius Configuration Profile
|
### Developing With Audita And Notarius Overlays
|
||||||
|
|
||||||
A Narratio development overlay can explicitly select a Notarius overlay without
|
All three applications use ConfigKit, but each owns its root configuration and
|
||||||
requiring the names to match. For example, `overlays/testing.yml` may contain:
|
its own `overlays/` directory beside that file. A Narratio testing overlay can
|
||||||
|
explicitly select downstream testing overlays without requiring their names to
|
||||||
|
match. For example, Narratio's `overlays/testing.yml` may contain:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
audita:
|
||||||
|
overlay: testing
|
||||||
notarius:
|
notarius:
|
||||||
config_profile: downstream-economy
|
config_overlay: downstream-economy
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Place Audita's settings in `overlays/testing.yml` beside its configuration, and
|
||||||
|
Notarius's settings in `overlays/downstream-economy.yml` beside its configuration.
|
||||||
|
Use each tool's own schema for model/profile selection and other settings;
|
||||||
|
Narratio neither copies those settings nor implicitly forwards its overlay name.
|
||||||
|
Select the Narratio file with `--overlay testing` on the desired command. Each
|
||||||
|
downstream selector is used only when its stage actually executes: `polish` for
|
||||||
|
Audita and `extract` for Notarius. Production can omit both selectors.
|
||||||
|
|
||||||
|
For Audita debug inspection, its testing overlay can include:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
diagnostics:
|
||||||
|
debug: true
|
||||||
|
work_dir: /path/to/audita-debug
|
||||||
|
```
|
||||||
|
|
||||||
|
Audita retains detailed artifacts under that directory. Inspect them there;
|
||||||
|
Narratio does not collect or manage them. Ordinary Audita reports remain a
|
||||||
|
separate existing integration. Leave debug disabled in Audita's production
|
||||||
|
configuration unless deliberately needed.
|
||||||
|
|
||||||
|
Notarius's debug controls are different: `debug.directory` selects a location
|
||||||
|
but does not enable capture. Capture requires its `--debug` flag, which Narratio
|
||||||
|
does not currently forward. Selecting a Notarius testing overlay therefore does
|
||||||
|
not by itself enable a debug bundle. See the upstream
|
||||||
|
[Audita configuration](https://gitea.maximumdirect.net/eric/audita/src/tag/v2.0.1/docs/config.md)
|
||||||
|
and [Notarius CLI](https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.8.1/docs/cli.md)
|
||||||
|
for their respective controls.
|
||||||
|
|
||||||
|
Edits inside downstream configuration behind an unchanged selector are not
|
||||||
|
automatically detected by Narratio. To inspect a fresh Audita debug run, explicitly
|
||||||
|
rerun polish, for example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
narratio run SESSION --overlay testing --force --from polish --through polish
|
||||||
|
```
|
||||||
|
|
||||||
|
This replaces polish output and invalidates dependent results; it is not a
|
||||||
|
diagnostics-only operation. Selecting testing does not create an isolated
|
||||||
|
workspace or retain a separate current result.
|
||||||
|
|
||||||
|
Notarius v0.8+ defaults to two additional eligible transient provider attempts
|
||||||
|
per generation. Review downstream retry settings and Narratio's extraction
|
||||||
|
timeout together; retries can increase elapsed time and provider charges.
|
||||||
|
Notarius v0.8.1 refreshes its built-in profile checkpoint identity, so older
|
||||||
|
checkpoints may not be reused. Source-keyed chunk plans and already published
|
||||||
|
outputs are unaffected; no manual cache deletion is required.
|
||||||
|
|
||||||
Selecting Narratio's `testing` overlay then supplies `downstream-economy` only
|
Selecting Narratio's `testing` overlay then supplies `downstream-economy` only
|
||||||
when extraction executes. Switching that explicit selector makes a recorded
|
when extraction executes. Switching that explicit selector makes a recorded
|
||||||
extraction non-current and reruns it when `extract` is in the selected stage
|
extraction non-current and reruns it when `extract` is in the selected stage
|
||||||
@@ -302,9 +354,11 @@ Narratio cannot observe edits inside Notarius configuration behind an unchanged
|
|||||||
selector. Force extraction after such an edit when a replacement is intended.
|
selector. Force extraction after such an edit when a replacement is intended.
|
||||||
Use `regenerate-artifacts` when both extraction and analysis must be rebuilt;
|
Use `regenerate-artifacts` when both extraction and analysis must be rebuilt;
|
||||||
use `analyze` when the existing extraction bundle should be preserved. Field
|
use `analyze` when the existing extraction bundle should be preserved. Field
|
||||||
semantics belong in [Configuration](./config.md#notarius-configuration-profile),
|
semantics belong in [Configuration](./config.md#notarius-configuration-overlay),
|
||||||
and the exact downstream invocation belongs in the
|
with Audita selectors covered under
|
||||||
[Notarius integration contract](./integrations/notarius.md#invocation).
|
[Audita selection and credentials](./config.md#audita-selection-and-credentials).
|
||||||
|
Exact downstream invocations belong in the [Audita](./integrations/audita.md)
|
||||||
|
and [Notarius](./integrations/notarius.md#invocation) integration contracts.
|
||||||
|
|
||||||
## Artifact Selection
|
## Artifact Selection
|
||||||
|
|
||||||
@@ -572,6 +626,8 @@ Publish commit model:
|
|||||||
|
|
||||||
- uploads eligible run files under `{session_prefix}/runs/{run_id}/`, excluding
|
- uploads eligible run files under `{session_prefix}/runs/{run_id}/`, excluding
|
||||||
audio and the run-local Notarius staging bundle;
|
audio and the run-local Notarius staging bundle;
|
||||||
|
- uploads prepared campaign, session, and party documents under the run's
|
||||||
|
`prepare/inputs/` prefix, when recorded by the manifest;
|
||||||
- uploads configured published outputs and `previous/**` cache files into the
|
- uploads configured published outputs and `previous/**` cache files into the
|
||||||
same immutable run scope, including only explicitly configured extraction
|
same immutable run scope, including only explicitly configured extraction
|
||||||
lanes;
|
lanes;
|
||||||
@@ -660,8 +716,8 @@ plan, so it is not a network-free operation.
|
|||||||
|
|
||||||
Default restore scope:
|
Default restore scope:
|
||||||
|
|
||||||
- the committed session manifest and the committed transcript/artifact objects
|
- the committed session manifest, prepared campaign/session/party documents,
|
||||||
declared by the selected remote commit
|
and transcript/artifact objects declared by the selected remote commit
|
||||||
- `previous/**` when needed by configured previous-session artifact inputs;
|
- `previous/**` when needed by configured previous-session artifact inputs;
|
||||||
each is selected from its exact committed `published_output` declaration
|
each is selected from its exact committed `published_output` declaration
|
||||||
|
|
||||||
@@ -767,7 +823,7 @@ ConfigKit.
|
|||||||
Every pipeline-loading command bootstraps credentials once, before the first
|
Every pipeline-loading command bootstraps credentials once, before the first
|
||||||
configuration load and before any adapter is constructed. `--secrets-dir`
|
configuration load and before any adapter is constructed. `--secrets-dir`
|
||||||
selects an explicit directory (relative paths use caller CWD). Otherwise a
|
selects an explicit directory (relative paths use caller CWD). Otherwise a
|
||||||
present `secrets/` beside the resolved root pipeline is used, while an absent
|
present `/usr/local/etc/narratio/secrets` directory is used, while an absent
|
||||||
conventional directory is skipped. Explicit missing/empty selections and
|
conventional directory is skipped. Explicit missing/empty selections and
|
||||||
invalid existing directories fail the command. ConfigKit follows a symlink used
|
invalid existing directories fail the command. ConfigKit follows a symlink used
|
||||||
as the selected directory, but immediate entries must be regular non-symlink
|
as the selected directory, but immediate entries must be regular non-symlink
|
||||||
|
|||||||
213
docs/oss/attribution.md
Normal file
213
docs/oss/attribution.md
Normal file
@@ -0,0 +1,213 @@
|
|||||||
|
# Open Source Attribution Notices
|
||||||
|
|
||||||
|
## Standard Repository Policies
|
||||||
|
|
||||||
|
Material: `docs/policy/agents.md`, `architecture.md`, `documentation.md`,
|
||||||
|
`testing.md`, `release.md`, `meta.md`, and `oss.md`; root `AGENTS.md` and the policy reading
|
||||||
|
guide in `docs/development.md`, adapted for this repository.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) |
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/COPYRIGHT) |
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4).
|
||||||
|
|
||||||
|
## ConfigKit
|
||||||
|
|
||||||
|
Selected module: `go.maximumdirect.net/configkit` at `v1.2.1`.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL 3.0](licenses/GPL-3.0.txt) |
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://forge.maximumdirect.net/base-layer/configkit/src/commit/51ef3144158db1a09fabdbd1c7ae59908c84923b).
|
||||||
|
|
||||||
|
## YAML v3
|
||||||
|
|
||||||
|
Selected module: `gopkg.in/yaml.v3` at `v3.0.1`.
|
||||||
|
|
||||||
|
Copyright (c) 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright (c) 2006-2011 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright (c) 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2011-2016 Canonical Ltd.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT AND Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [MIT](licenses/MIT.txt) |
|
||||||
|
[Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE](https://github.com/go-yaml/yaml/blob/f6f7691b1fdeb513f56608cd2c32c51f8194bf51/LICENSE) |
|
||||||
|
[NOTICE](https://github.com/go-yaml/yaml/blob/f6f7691b1fdeb513f56608cd2c32c51f8194bf51/NOTICE).
|
||||||
|
|
||||||
|
[Source](https://github.com/go-yaml/yaml/commit/f6f7691b1fdeb513f56608cd2c32c51f8194bf51).
|
||||||
|
|
||||||
|
## YAML v4
|
||||||
|
|
||||||
|
Selected module: `go.yaml.in/yaml/v4` at `v4.0.0`.
|
||||||
|
|
||||||
|
Copyright 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2025 The go-yaml Project Contributors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT AND Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [MIT](licenses/MIT.txt) |
|
||||||
|
[Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE](https://github.com/yaml/go-yaml/blob/f2f9563503f11b7a60da0c532175dcc693ce8d5a/LICENSE) |
|
||||||
|
[NOTICE](https://github.com/yaml/go-yaml/blob/f2f9563503f11b7a60da0c532175dcc693ce8d5a/NOTICE).
|
||||||
|
|
||||||
|
[Source](https://github.com/yaml/go-yaml/commit/f2f9563503f11b7a60da0c532175dcc693ce8d5a).
|
||||||
|
|
||||||
|
## go-cmp
|
||||||
|
|
||||||
|
Selected module: `github.com/google/go-cmp` at `v0.7.0` (test-only).
|
||||||
|
|
||||||
|
Copyright (c) 2017 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/google/go-cmp/blob/9b12f366a942ebc7254abc7f32ca05068b455fb7/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/google/go-cmp/commit/9b12f366a942ebc7254abc7f32ca05068b455fb7).
|
||||||
|
|
||||||
|
## Go sync extension
|
||||||
|
|
||||||
|
Selected module: `golang.org/x/sync` at `v0.22.0`.
|
||||||
|
|
||||||
|
Copyright 2009 The Go Authors.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/golang/sync/blob/1eb64d4bc0cde6da1bb8ebc7f178bb577508e5d0/LICENSE) |
|
||||||
|
[PATENTS](https://github.com/golang/sync/blob/1eb64d4bc0cde6da1bb8ebc7f178bb577508e5d0/PATENTS).
|
||||||
|
|
||||||
|
[Source](https://github.com/golang/sync/commit/1eb64d4bc0cde6da1bb8ebc7f178bb577508e5d0).
|
||||||
|
|
||||||
|
## Go system extension
|
||||||
|
|
||||||
|
Selected module: `golang.org/x/sys` at `v0.47.0`.
|
||||||
|
|
||||||
|
Copyright 2009 The Go Authors.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/golang/sys/blob/9e7e939dcafac07e8ab4cffa6e5fc74908413f00/LICENSE) |
|
||||||
|
[PATENTS](https://github.com/golang/sys/blob/9e7e939dcafac07e8ab4cffa6e5fc74908413f00/PATENTS).
|
||||||
|
|
||||||
|
[Source](https://github.com/golang/sys/commit/9e7e939dcafac07e8ab4cffa6e5fc74908413f00).
|
||||||
|
|
||||||
|
## Go runtime and standard library
|
||||||
|
|
||||||
|
Material: Go `1.27.4` runtime and standard library material incorporated in
|
||||||
|
release binaries built with the declared `golang:1.27.4` CI toolchain.
|
||||||
|
|
||||||
|
Copyright 2009 The Go Authors.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/golang/go/blob/7b2881024c95a11ddb86663a616340aa3a88b67f/LICENSE) |
|
||||||
|
[PATENTS](https://github.com/golang/go/blob/7b2881024c95a11ddb86663a616340aa3a88b67f/PATENTS).
|
||||||
|
|
||||||
|
[Source](https://github.com/golang/go/commit/7b2881024c95a11ddb86663a616340aa3a88b67f).
|
||||||
|
|
||||||
|
## AWS SDK for Go v2
|
||||||
|
|
||||||
|
Selected modules under `github.com/aws/aws-sdk-go-v2` at source revision
|
||||||
|
`2223642aeafb3b46ae924667ee47d31a1cf5a9d5`: root `v1.41.7`,
|
||||||
|
`aws/protocol/eventstream` `v1.7.10`, `config` `v1.32.17`, `credentials`
|
||||||
|
`v1.19.16`, `feature/ec2/imds` `v1.18.23`, `internal/configsources`
|
||||||
|
`v1.4.23`, `internal/endpoints/v2` `v2.7.23`, `internal/v4a` `v1.4.24`,
|
||||||
|
`service/internal/accept-encoding` `v1.13.9`, `service/internal/checksum`
|
||||||
|
`v1.9.15`, `service/internal/presigned-url` `v1.13.23`,
|
||||||
|
`service/internal/s3shared` `v1.19.23`, `service/signin` `v1.0.11`,
|
||||||
|
`service/sso` `v1.30.17`, `service/ssooidc` `v1.35.21`, and `service/sts`
|
||||||
|
`v1.42.1`.
|
||||||
|
|
||||||
|
Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||||
|
|
||||||
|
Copyright 2014-2015 Stripe, Inc.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE.txt](https://github.com/aws/aws-sdk-go-v2/blob/2223642aeafb3b46ae924667ee47d31a1cf5a9d5/LICENSE.txt) |
|
||||||
|
[NOTICE.txt](https://github.com/aws/aws-sdk-go-v2/blob/2223642aeafb3b46ae924667ee47d31a1cf5a9d5/NOTICE.txt).
|
||||||
|
|
||||||
|
[Source](https://github.com/aws/aws-sdk-go-v2/commit/2223642aeafb3b46ae924667ee47d31a1cf5a9d5).
|
||||||
|
|
||||||
|
## AWS SDK for Go v2 S3
|
||||||
|
|
||||||
|
Selected module: `github.com/aws/aws-sdk-go-v2/service/s3` at `v1.101.0`.
|
||||||
|
|
||||||
|
Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||||
|
|
||||||
|
Copyright 2014-2015 Stripe, Inc.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE.txt](https://github.com/aws/aws-sdk-go-v2/blob/84ddd08980744ac0f3bacfe7d2796c861671accc/service/s3/LICENSE.txt) |
|
||||||
|
[NOTICE.txt](https://github.com/aws/aws-sdk-go-v2/blob/84ddd08980744ac0f3bacfe7d2796c861671accc/NOTICE.txt).
|
||||||
|
|
||||||
|
[Source](https://github.com/aws/aws-sdk-go-v2/commit/84ddd08980744ac0f3bacfe7d2796c861671accc).
|
||||||
|
|
||||||
|
## AWS Smithy Go
|
||||||
|
|
||||||
|
Selected module: `github.com/aws/smithy-go` at `v1.25.1`.
|
||||||
|
|
||||||
|
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[LICENSE](https://github.com/aws/smithy-go/blob/e094f45e716e33a1b950cf8bbe804790bf87f965/LICENSE) |
|
||||||
|
[NOTICE](https://github.com/aws/smithy-go/blob/e094f45e716e33a1b950cf8bbe804790bf87f965/NOTICE).
|
||||||
|
|
||||||
|
[Source](https://github.com/aws/smithy-go/commit/e094f45e716e33a1b950cf8bbe804790bf87f965).
|
||||||
|
|
||||||
|
## Go singleflight in AWS SDK for Go v2
|
||||||
|
|
||||||
|
Material: `internal/sync/singleflight` in the selected AWS SDK root module.
|
||||||
|
|
||||||
|
Copyright (c) 2009 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Copyright 2013 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/aws/aws-sdk-go-v2/blob/2223642aeafb3b46ae924667ee47d31a1cf5a9d5/internal/sync/singleflight/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/aws/aws-sdk-go-v2/commit/2223642aeafb3b46ae924667ee47d31a1cf5a9d5).
|
||||||
|
|
||||||
|
## Go singleflight in AWS Smithy Go
|
||||||
|
|
||||||
|
Material: `internal/sync/singleflight` in the selected smithy-go module.
|
||||||
|
|
||||||
|
Copyright (c) 2009 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Copyright 2013 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[LICENSE](https://github.com/aws/smithy-go/blob/e094f45e716e33a1b950cf8bbe804790bf87f965/internal/sync/singleflight/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/aws/smithy-go/commit/e094f45e716e33a1b950cf8bbe804790bf87f965).
|
||||||
202
docs/oss/licenses/Apache-2.0.txt
Normal file
202
docs/oss/licenses/Apache-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
11
docs/oss/licenses/BSD-3-Clause.txt
Normal file
11
docs/oss/licenses/BSD-3-Clause.txt
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
Copyright (c) <year> <owner>.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
Creative Commons Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
|
||||||
|
|
||||||
|
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||||
|
|
||||||
|
Section 1 – Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
Section 2 – Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||||
|
|
||||||
|
B. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section 6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
|
||||||
|
|
||||||
|
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
Section 3 – License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified form), You must:
|
||||||
|
|
||||||
|
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||||
|
|
||||||
|
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
Section 4 – Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||||
|
|
||||||
|
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 – Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||||
|
|
||||||
|
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||||
|
|
||||||
|
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||||
|
|
||||||
|
Section 7 – Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 – Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
674
docs/oss/licenses/GPL-3.0.txt
Normal file
674
docs/oss/licenses/GPL-3.0.txt
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
165
docs/oss/licenses/LGPL-3.0.txt
Normal file
165
docs/oss/licenses/LGPL-3.0.txt
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
18
docs/oss/licenses/MIT.txt
Normal file
18
docs/oss/licenses/MIT.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) <year> <copyright holders>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
||||||
|
following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial
|
||||||
|
portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
||||||
|
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
||||||
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
@@ -1,12 +1,14 @@
|
|||||||
# Agent Policy
|
# Agent Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.1
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated**: 2026-09-25
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/agents.md
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Agents working in this repository must read and adhere to the following house rules.
|
Agents must read and follow these rules.
|
||||||
|
|
||||||
## Implementation Discipline
|
## Implementation Discipline
|
||||||
|
|
||||||
@@ -14,8 +16,6 @@ Agents working in this repository must read and adhere to the following house ru
|
|||||||
request. Do not implicitly strengthen requirements, restrictions, or guarantees
|
request. Do not implicitly strengthen requirements, restrictions, or guarantees
|
||||||
beyond what the user actually requested.
|
beyond what the user actually requested.
|
||||||
|
|
||||||
Simplify the mechanism, not the user's choices.
|
|
||||||
|
|
||||||
**Keep implementation machinery proportionate.** Use straightforward,
|
**Keep implementation machinery proportionate.** Use straightforward,
|
||||||
idiomatic code and introduce only the machinery needed to support the requested
|
idiomatic code and introduce only the machinery needed to support the requested
|
||||||
behavior and flexibility. Optimize for conceptual simplicity and
|
behavior and flexibility. Optimize for conceptual simplicity and
|
||||||
@@ -29,11 +29,6 @@ operator and caller choice where policy has not been established. If an
|
|||||||
additional restriction appears advisable, present it as a decision rather than
|
additional restriction appears advisable, present it as a decision rather than
|
||||||
silently implementing it.
|
silently implementing it.
|
||||||
|
|
||||||
A correctness constraint must follow from the requested behavior or an
|
|
||||||
established invariant, not from the convenience of the chosen implementation.
|
|
||||||
Explain the specific failure it prevents and why a less restrictive
|
|
||||||
implementation cannot satisfy the contract.
|
|
||||||
|
|
||||||
**Do not invent guarantees.** Do not strengthen public contracts, guarantees,
|
**Do not invent guarantees.** Do not strengthen public contracts, guarantees,
|
||||||
or invariants beyond those expressly requested by the user.
|
or invariants beyond those expressly requested by the user.
|
||||||
|
|
||||||
@@ -46,30 +41,19 @@ idiomatic approach unless another path is expressly requested by the user.
|
|||||||
|
|
||||||
**An implementation detail is not repository policy.** Tests and documentation
|
**An implementation detail is not repository policy.** Tests and documentation
|
||||||
must not elevate incidental behavior into a durable guarantee or restriction
|
must not elevate incidental behavior into a durable guarantee or restriction
|
||||||
unless that behavior was expressly selected as part of the contract. Existing
|
unless that behavior was expressly selected as part of the contract.
|
||||||
explicit contracts remain authoritative; changing or weakening one requires a
|
|
||||||
deliberate decision rather than being inferred from this principle.
|
|
||||||
|
|
||||||
Agent-authored plans, tests, documentation, and prior implementations are not
|
|
||||||
evidence that an additional restriction was deliberately approved. Identify the
|
|
||||||
authorizing requirement or decision; when that authority is unclear, surface
|
|
||||||
the ambiguity rather than treating repetition as approval.
|
|
||||||
|
|
||||||
Standard-library guidance does not authorize weakening Narratio's established
|
|
||||||
filesystem, manifest, or publication contracts. Preserve them unless a deliberate
|
|
||||||
decision changes them.
|
|
||||||
|
|
||||||
## Git Commit Policy
|
## Git Commit Policy
|
||||||
|
|
||||||
By default, create a commit after completing each coherent unit of work, using a
|
By default, commit each completed, nonempty unit of work using a
|
||||||
concise, plain-English message describing what changed. This policy is standing
|
concise, plain-English message describing what changed. This policy is standing
|
||||||
authorization to create those local commits; a separate user request is not
|
authorization to create those local commits; a separate user request is not
|
||||||
required. An explicit user instruction to leave work uncommitted takes precedence.
|
required. An explicit user instruction to leave work uncommitted takes precedence.
|
||||||
|
|
||||||
A unit of work is a focused, reviewable outcome, including its relevant tests and
|
A unit of work is a focused, reviewable outcome, including its relevant tests and
|
||||||
documentation. Do not commit after every intermediate edit or create empty commits.
|
documentation.
|
||||||
Complete the appropriate validation before committing. If work is incomplete or
|
Complete the appropriate validation before committing. If work is incomplete or
|
||||||
validation is blocked, report that state rather than presenting it as completed.
|
validation is blocked, report that state accurately.
|
||||||
|
|
||||||
Before committing:
|
Before committing:
|
||||||
|
|
||||||
@@ -77,10 +61,10 @@ Before committing:
|
|||||||
changes. Identify changes that predate the current unit of work.
|
changes. Identify changes that predate the current unit of work.
|
||||||
2. Exclude secrets, local environment files, generated junk, and unrelated changes.
|
2. Exclude secrets, local environment files, generated junk, and unrelated changes.
|
||||||
3. Stage only the files or hunks belonging to the completed unit. Use `git add .`
|
3. Stage only the files or hunks belonging to the completed unit. Use `git add .`
|
||||||
only when every included change belongs to that unit. Do not disturb unrelated
|
only when every included change belongs to that unit. Preserve unrelated
|
||||||
staged or unstaged work.
|
staged and unstaged work.
|
||||||
4. Review `git diff --staged` and run appropriate checks for the change. Do not
|
4. Review `git diff --staged` and run appropriate checks for the change. Reuse
|
||||||
repeat checks already passed for unchanged content merely to create a commit.
|
successful checks for unchanged content.
|
||||||
5. Review `git log --oneline -n 10` and use
|
5. Review `git log --oneline -n 10` and use
|
||||||
`git commit -m "<concise plain-English commit message>"`.
|
`git commit -m "<concise plain-English commit message>"`.
|
||||||
6. Report the commit identifier and any remaining uncommitted work.
|
6. Report the commit identifier and any remaining uncommitted work.
|
||||||
|
|||||||
@@ -1,14 +1,41 @@
|
|||||||
# Architecture
|
# Architecture Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated**: 2026-09-25
|
**Last Updated**: 2026-11-19
|
||||||
|
|
||||||
This document defines Narratio's intended high-level architecture and the
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/architecture.md
|
||||||
invariants that changes must preserve. Implemented component details belong in
|
|
||||||
the [Internal Overview](../internal/overview.md) and its linked documents.
|
## Purpose And Ownership
|
||||||
Significant architectural decision history belongs under `docs/adr/` when such
|
|
||||||
records exist.
|
The adopted policy defines the application's purpose and the architectural
|
||||||
|
constraints contributors must follow. It owns system boundaries, responsibility
|
||||||
|
and dependency rules, established invariants, and explicit non-goals.
|
||||||
|
|
||||||
|
Describe the concrete package inventory and implementation mechanics in internal
|
||||||
|
documentation. Link to canonical public contracts for their exact behavior and
|
||||||
|
to ADRs for decision rationale.
|
||||||
|
|
||||||
|
## Architectural Approach
|
||||||
|
|
||||||
|
Hexagonal architecture is strongly recommended, including encapsulating external
|
||||||
|
integrations and APIs within internal adapters. Keep domain and application
|
||||||
|
logic independent of external integration details, and make dependency direction
|
||||||
|
clear in the adopted policy.
|
||||||
|
|
||||||
|
Implement that separation with proportionate, idiomatic code. Choose interfaces
|
||||||
|
and package layout to serve the application's actual boundaries. Use adapters
|
||||||
|
for collaborators with external integration responsibilities.
|
||||||
|
|
||||||
|
## Adopted Constraints And Implemented Structure
|
||||||
|
|
||||||
|
Architectural constraints govern current and future development. Record
|
||||||
|
implemented structure accurately, proposals and implementation status in the
|
||||||
|
roadmap, and significant decisions and rationale in ADRs. Describe a target
|
||||||
|
structure as implemented when its changes land.
|
||||||
|
|
||||||
|
Constraints must reflect deliberately selected requirements and decisions.
|
||||||
|
Do not promote incidental implementation choices into architectural invariants.
|
||||||
|
|
||||||
## System Shape
|
## System Shape
|
||||||
|
|
||||||
@@ -25,7 +52,7 @@ their domains:
|
|||||||
- Notarius extracts validated structured artifact bundles; and
|
- Notarius extracts validated structured artifact bundles; and
|
||||||
- Scriptorium executes prompts and produces configured artifacts.
|
- Scriptorium executes prompts and produces configured artifacts.
|
||||||
|
|
||||||
Narratio owns orchestration, configuration resolution, session and run state,
|
Narratio owns orchestration, configuration interpretation, session and run state,
|
||||||
artifact and path modeling, manifest persistence, stage sequencing, resume,
|
artifact and path modeling, manifest persistence, stage sequencing, resume,
|
||||||
restore, cleanup gates, and publish semantics. External contracts are defined
|
restore, cleanup gates, and publish semantics. External contracts are defined
|
||||||
in the [integration documentation](../integrations/).
|
in the [integration documentation](../integrations/).
|
||||||
@@ -46,7 +73,7 @@ itself an architectural goal.
|
|||||||
|
|
||||||
## Ownership And Dependency Direction
|
## Ownership And Dependency Direction
|
||||||
|
|
||||||
The application boundary owns command dispatch, configuration selection,
|
The application boundary owns command composition, configuration selection,
|
||||||
production composition, session locking, and top-level lifecycle. It may depend
|
production composition, session locking, and top-level lifecycle. It may depend
|
||||||
on concrete implementations to assemble a run.
|
on concrete implementations to assemble a run.
|
||||||
|
|
||||||
@@ -145,18 +172,30 @@ or other non-regular conflict into a successful restore.
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Configuration is strict, explicit, centralized, and operator-oriented.
|
Configuration ownership follows
|
||||||
|
[ADR 0003](../adr/0003-assign-configuration-ownership.md):
|
||||||
|
|
||||||
|
- ConfigKit owns configuration policy and resolution through the final handoff.
|
||||||
|
Narratio supplies its schema, defaults, and configuration rules through
|
||||||
|
supported extension points. The completed ConfigKit result is authoritative.
|
||||||
|
- Narratio consumes that result without mutation and derives separate domain
|
||||||
|
objects. It must not construct a replacement effective configuration.
|
||||||
|
- CommandKit owns CLI mechanics and presentation; `ckconfig` exposes ConfigKit
|
||||||
|
inspection. Narratio supplies selection and acquisition wiring through native
|
||||||
|
adapters without changing upstream semantics or substituting inspection views.
|
||||||
|
|
||||||
|
Missing configuration or inspection capabilities are addressed upstream.
|
||||||
|
|
||||||
- YAML decoding rejects unknown fields.
|
- YAML decoding rejects unknown fields.
|
||||||
- Defaults are centralized and testable.
|
- Defaults are centralized and testable.
|
||||||
- Empty configured values do not silently replace meaningful defaults.
|
- Defaults apply only to absent fields. Explicit false, zero, empty, and null
|
||||||
|
values remain present and are evaluated by Narratio's domain rules.
|
||||||
- Validation rejects invalid configuration before stage execution where
|
- Validation rejects invalid configuration before stage execution where
|
||||||
practical.
|
practical.
|
||||||
- Root-owned imports and one selected overlay resolve deterministically through
|
- ConfigKit resolves local imports and the selected pipeline overlay.
|
||||||
the configuration owner; commands do not implement their own merge rules.
|
- Canonical party rosters are campaign-owned inputs. Narratio derives players
|
||||||
- Canonical party rosters are campaign-owned. Their derived players projection
|
projections and concrete character-family artifacts as separate domain
|
||||||
and concrete character-family artifacts are resolved before runtime stages
|
objects before execution, without modifying configuration.
|
||||||
or adapters receive configuration.
|
|
||||||
- Resume uses stage- or artifact-owned semantic evidence for observable
|
- Resume uses stage- or artifact-owned semantic evidence for observable
|
||||||
result-affecting configuration; overlay identity and an effective digest are
|
result-affecting configuration; overlay identity and an effective digest are
|
||||||
provenance, never blanket cache keys.
|
provenance, never blanket cache keys.
|
||||||
|
|||||||
@@ -1,13 +1,15 @@
|
|||||||
# Documentation Policy
|
# Documentation Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.1
|
**Base Policy Version:** 1.12
|
||||||
|
|
||||||
**Last Updated**: 2026-09-25
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/documentation.md
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
This policy assigns each documentation topic to one canonical owner. Its goal is
|
This policy assigns each documentation topic to one canonical owner. Its goal is
|
||||||
to keep Narratio documentation accurate, concise, discoverable, and resistant
|
to keep this application's documentation accurate, concise, discoverable, and resistant
|
||||||
to drift for users, operators, developers, integrators, and LLM coding agents.
|
to drift for users, operators, developers, integrators, and LLM coding agents.
|
||||||
|
|
||||||
## Core Rules
|
## Core Rules
|
||||||
@@ -16,36 +18,38 @@ to drift for users, operators, developers, integrators, and LLM coding agents.
|
|||||||
|
|
||||||
Each authoritative fact belongs in one document. A non-owning document may give
|
Each authoritative fact belongs in one document. A non-owning document may give
|
||||||
a short, stable summary for orientation, but it must link to the canonical owner
|
a short, stable summary for orientation, but it must link to the canonical owner
|
||||||
instead of repeating volatile details.
|
for volatile details.
|
||||||
|
|
||||||
Volatile details include commands, flags, configuration fields and defaults,
|
Volatile details include commands, flags, configuration fields and defaults,
|
||||||
stage or integration keys, schemas, file names, paths, status codes, retry
|
module keys, schemas, file names, paths, status codes, retry behavior, and
|
||||||
behavior, and runtime guarantees. If readers could reasonably treat a statement
|
runtime guarantees. If readers could reasonably treat a statement as a
|
||||||
as a contract, maintain it only in the owning document.
|
contract, maintain it only in the owning document.
|
||||||
|
|
||||||
### Current And Future Behavior
|
### Current And Future Behavior
|
||||||
|
|
||||||
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
||||||
Partial features may be described only to their implemented boundary.
|
Partial features may be described only to their implemented boundary.
|
||||||
|
|
||||||
ADRs are the narrow exception: an ADR may record an accepted architectural
|
Architectural constraints may govern future changes. Describe current structure
|
||||||
decision before implementation, but acceptance must not be presented as proof
|
from implemented behavior.
|
||||||
that the behavior exists. The roadmap owns implementation status and sequencing
|
|
||||||
until the decision is implemented. Current architecture, user, operator,
|
ADRs may record an accepted architectural decision before implementation. The
|
||||||
integration, and internal documentation are updated when the behavior lands.
|
roadmap owns implementation status and sequencing until the decision is
|
||||||
|
implemented. Current architecture, user, operator, integration, and internal
|
||||||
|
documentation are updated when the behavior lands.
|
||||||
|
|
||||||
### Audience And Detail
|
### Audience And Detail
|
||||||
|
|
||||||
Write for the document's stated audience and include only the detail needed for
|
Write for the document's stated audience and include only the detail needed for
|
||||||
its owned topic. User and operator docs should not expose implementation detail.
|
its owned topic. Keep user and operator docs focused on using and operating the
|
||||||
Developer docs should link to user-facing and external contracts rather than
|
application. Developer docs should link to user-facing and external contracts
|
||||||
restate them.
|
for their definitions.
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
Complete copyable files belong in `examples/`. Documentation may use the
|
Complete copyable files belong in `examples/`. Documentation may use the
|
||||||
smallest illustrative snippet needed to explain its owned topic, but should link
|
smallest illustrative snippet needed to explain its owned topic, but should link
|
||||||
to maintained examples instead of embedding a second complete copy.
|
to maintained examples for complete copyable files.
|
||||||
|
|
||||||
Examples must be valid, secret-free, and tested where practical. Commands and
|
Examples must be valid, secret-free, and tested where practical. Commands and
|
||||||
configuration used in documentation should match the application.
|
configuration used in documentation should match the application.
|
||||||
@@ -61,63 +65,69 @@ secret values.
|
|||||||
|
|
||||||
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| Product orientation and minimal end-to-end quickstart | `README.md` | What Narratio is, why it is useful, one shortest successful invocation, and links onward. | Complete command reference, configuration reference, operational procedures, implementation detail. |
|
| Product orientation and minimal end-to-end quickstart | `README.md` | Purpose, value, shortest successful invocation, and navigation, including licensing and attribution. | Complete command reference, configuration reference, operational procedures, implementation detail. |
|
||||||
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, minimal contributor orientation, baseline validation commands, and links to canonical docs. | Package inventory, architecture rules, subsystem behavior, detailed change recipes. |
|
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, contributor orientation, baseline validation commands, and canonical links. | Package inventory, architecture rules, subsystem behavior, detailed change recipes. |
|
||||||
| Agent policy | `docs/policy/agents.md` | Agent implementation discipline, authority boundaries, and local commit policy. | Application contracts, architecture, testing policy, and contributor procedures. |
|
| Application architecture policy | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
|
||||||
| Release policy | `docs/policy/release.md` | Versioning, release integrity, documentation and validation requirements, immutability, publication controls, and explicit exceptions. | Repository-specific commands, installation, historical summaries, and CI implementation detail. |
|
| Policy-set provenance and upstream navigation | `docs/policy/meta.md` | Policy-set origin, local authority, adoption baselines, and upstream adoption and update links. | Task-specific reading triggers, detailed adoption procedures, and formal attribution notices. |
|
||||||
| Maintainer release procedure | `docs/release.md` | Prerequisites, concrete candidate validation and publication commands, deliverables, failure recovery, and optional consumer-facing inspection. | General release requirements and exceptions, current application contracts, and historical release summaries. |
|
| Agent policy | `docs/policy/agents.md` | Proportionate, idiomatic implementation; rules against inventing requirements, restrictions, guarantees, or policy. | Application contracts, architecture, testing policy, and contributor procedures. |
|
||||||
| Historical release summary | `docs/releases/<tag>.md` | Immutable summary, compatibility, upgrade, and changes for one released version. | Current maintainer procedure and current application contract details. |
|
| Documentation policy | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
|
||||||
| Current application architecture | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, architectural boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
|
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk sufficiency, boundaries, doubles, coverage, regressions, and test maintenance. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
||||||
| Documentation organization | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
|
| Release policy | `docs/policy/release.md` | Versioning, compatibility, release integrity and immutability, release documentation, proportionate gates, publication controls, completion, and required versus optional checks. | Repository-specific commands, product installation guidance, CLI version semantics, historical release summaries, and CI implementation detail. |
|
||||||
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk-based sufficiency, test boundaries, doubles, coverage guidance, regression-test policy, and criteria for adding, rewriting, or deleting tests. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
| Open source licensing and attribution policy | `docs/policy/oss.md` | License defaults and author choices, COPYRIGHT and attribution formats, license/notice links, discoverability, maintenance, and concrete exceptions. | Component entries, license texts, release commands, and dependency security review. |
|
||||||
| CLI contract | `docs/cli.md` | Commands, arguments, flags, invocation semantics, output conventions, and exit behavior. | End-to-end operating procedures, configuration field definitions, runtime filesystem layout, stage implementation details. |
|
| Project copyright and license grant | `COPYRIGHT` | Project identity, copyright holders and years, SPDX expression, grant, warranty disclaimer, and third-party statement. | Complete license texts and upstream component attribution. |
|
||||||
| Configuration contract | `docs/config.md` | Discovery and precedence, file schemas, fields, defaults, environment overrides, validation rules, and user-selectable stage or integration settings. | Complete example files, CLI syntax, runtime state lifecycle, implementation details. |
|
| Project license texts | `LICENSE` | Complete project and incorporated companion license texts, with required project-specific fields. | General licensing policy and upstream component attribution. |
|
||||||
| Operations | `docs/operations.md` | Runtime workflows, physical filesystem and remote-state layout, output and diagnostic handling, resume, cleanup, permissions, recovery, and operational limits. | CLI flag syntax, configuration field definitions, logical artifact schemas, implementation mechanics. |
|
| Upstream component attribution | `docs/oss/attribution.md` | House Format component entries: identity, material scope and modifications where applicable, copyright, license, required notices, and license, notice, and source links. | General attribution policy, exception reasoning, research narratives, compliance commentary, and complete standard license texts. |
|
||||||
| Troubleshooting | `docs/troubleshooting.md` | Symptom-driven diagnosis, likely causes, safe inspection steps and remedies, and links to relevant contracts. | CLI syntax, configuration definitions, operational procedures, integration contracts, implementation mechanics. |
|
| Standard dependency license texts | `docs/oss/licenses/` | Complete, verbatim standard license texts shared by applicable entries. | Project-specific upstream notices, attribution prose, and policy interpretation. |
|
||||||
| Public HTTP contract, if introduced | `docs/api.md` | Routes, authentication, media types, request and response schemas, status codes, pagination, caching, idempotency, rate limits, and HTTP retry semantics. | Client walkthroughs, upstream or downstream integration internals, implementation detail. |
|
| Repository-specific release procedure | `docs/release.md` | Maintainer prerequisites, candidate preparation, validation and publication commands and automated guards, asynchronous deliverables, delivery status, optional consumer verification, and recovery. | General release requirements, product installation guidance, historical release summaries, and current compatibility contracts. |
|
||||||
| Consumer guidance, if a public package or API is introduced | `docs/consumers/` | Task-oriented use of the public interface, minimal client examples, and consumer responsibilities. | HTTP wire semantics, external protocol contracts, internal implementation detail. |
|
| CLI contract (if applicable) | `docs/cli.md` | Commands, arguments, flags, invocation semantics, and exit codes. | End-to-end operating procedures, configuration field definitions, runtime filesystem layout, module implementation details. |
|
||||||
| External and durable integration contracts | `docs/integrations/` | External file formats and protocols, upstream and downstream contracts, logical artifact paths and schemas, media types, and compatibility behavior. | Physical runtime placement and lifecycle, internal transformations, CLI syntax, configuration defaults. |
|
| Configuration contract (if applicable) | `docs/config.md` | Discovery, precedence, schema, fields, defaults, environment overrides, validation, and selectable module and validator keys. | Complete example files, CLI syntax, runtime state lifecycle, module implementation details. |
|
||||||
| Implemented component inventory | `docs/internal/overview.md` | Current packages and components, their implemented responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
| Operations (if applicable) | `docs/operations.md` | Runtime workflows, physical filesystem and state layout, output, cache and debug handling, resume, cleanup, permissions, recovery, and limits. | CLI flag syntax, configuration field definitions, logical output schemas, implementation mechanics. |
|
||||||
| Internal component behavior | Other files under `docs/internal/` | Implementation flow, internal collaborators and state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
| Troubleshooting | `docs/troubleshooting.md` | Symptom-driven diagnosis, likely causes, safe inspection, and remedies. | Canonical commands, configuration definitions, operational procedures, and integration contracts. |
|
||||||
| Architectural decision history | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. |
|
| Integration contracts for external components (if applicable) | `docs/integrations/` | External formats and protocols, upstream and downstream contracts, logical output paths and schemas, media types, and compatibility. | Physical runtime placement and lifecycle, internal transformations, CLI syntax, configuration defaults. |
|
||||||
| Future work and implementation status | `docs/roadmap/` | Proposed, accepted, deferred, or rejected work; implementation status; sequencing; and task breakdowns. | Implemented behavior reference and architectural decision rationale. |
|
| Inventory of implemented internal packages | `docs/internal/overview.md` | Implemented packages and components, responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
||||||
| Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other files intended to be copied or run. | Field-by-field reference, command reference, prose explanation. |
|
| Behavior and architecture of internal packages | Other files under `docs/internal/` | Implementation flow, collaborators, state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
||||||
|
| Architectural decision records | `docs/adr/` | Records of significant architectural decisions and supporting rationale. | Ordinary design choices, current behavior reference, implementation status, task sequencing. |
|
||||||
|
| Future work and implementation status | `docs/roadmap/` | Proposed, accepted, or future work; implementation status, sequencing, and task breakdowns. | Implemented behavior reference and architectural decision rationale. |
|
||||||
|
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
||||||
|
| Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other copyable or runnable files. | Field-by-field reference, command reference, prose explanation. |
|
||||||
|
|
||||||
Documents that do not exist are required only when the corresponding interface
|
Create supporting documents for existing interfaces and responsibilities when
|
||||||
or responsibility exists. Do not create placeholder API, consumer, integration,
|
substantive content is available.
|
||||||
or operations documents for behavior the application does not have.
|
|
||||||
|
|
||||||
## Boundary Rules
|
## Boundary Rules
|
||||||
|
|
||||||
### Orientation
|
### Orientation
|
||||||
|
|
||||||
The README owns product orientation. The developer guide routes contributors.
|
Link among orientation, architecture, and internal documents; maintain each
|
||||||
Architecture owns normative structure. Internal overview owns the current
|
package or behavior description in its canonical owner.
|
||||||
concrete component map. These documents may link to one another but should not
|
|
||||||
maintain parallel package or behavior descriptions.
|
|
||||||
|
|
||||||
### Commands, Configuration, Operations, And Troubleshooting
|
### Commands, Configuration, Operations, And Troubleshooting
|
||||||
|
|
||||||
CLI documentation answers how to invoke the application. Configuration
|
CLI documentation answers how to invoke the application. Configuration
|
||||||
documentation answers what settings mean. Operations answers what happens to
|
documentation answers what settings mean. Operations answers what happens to
|
||||||
runtime state and how to operate or recover the application. Troubleshooting
|
runtime state and how to operate or recover the application. When a workflow
|
||||||
starts from observable symptoms and links readers to the owning command,
|
crosses these topics, choose the document that owns the task and link to the
|
||||||
configuration, operational, or integration contract. When a workflow crosses
|
other contracts. Troubleshooting begins with observable symptoms and links to the owning contract.
|
||||||
these topics, choose the document that owns the task and link to the other
|
|
||||||
contracts.
|
|
||||||
|
|
||||||
### Releases
|
### Releases
|
||||||
|
|
||||||
[Release policy](release.md) owns requirements and explicit exceptions;
|
The release policy defines requirements and invariants that every release must
|
||||||
[the release procedure](../release.md) owns the commands used to satisfy them.
|
satisfy. The repository-specific release procedure defines the commands and
|
||||||
Release notes record history at an immutable tag. Neither the procedure nor a
|
workflow maintainers use to satisfy that policy. Release notes record history
|
||||||
release note may silently weaken policy or substitute for updates to current
|
at immutable tags. Maintain current behavior in its canonical documentation,
|
||||||
canonical documentation.
|
update it with the corresponding behavior changes, and keep release procedures
|
||||||
|
consistent with adopted policy.
|
||||||
|
|
||||||
|
### Project Licensing And Upstream Attribution
|
||||||
|
|
||||||
|
README and release documents link to the canonical licensing and attribution
|
||||||
|
materials under the [OSS policy](oss.md). The release procedure owns URL
|
||||||
|
construction and publication mechanics.
|
||||||
|
|
||||||
### Contracts And Implementation
|
### Contracts And Implementation
|
||||||
|
|
||||||
Integration and API documents define externally observable shapes and
|
Integration and API documents define externally observable shapes and
|
||||||
semantics. Internal documents explain how Narratio implements or consumes those
|
semantics. Internal documents explain how this application implements or consumes those
|
||||||
contracts. Internal docs may name a field, file, or protocol to identify a
|
contracts. Internal docs may name a field, file, or protocol to identify a
|
||||||
dependency, but must link to its canonical contract for the definition.
|
dependency, but must link to its canonical contract for the definition.
|
||||||
|
|
||||||
@@ -126,8 +136,7 @@ dependency, but must link to its canonical contract for the definition.
|
|||||||
This policy owns what documentation and examples may contain. Architecture owns
|
This policy owns what documentation and examples may contain. Architecture owns
|
||||||
application security invariants. Configuration owns credential-supply
|
application security invariants. Configuration owns credential-supply
|
||||||
mechanisms. Operations owns permissions and handling of sensitive runtime
|
mechanisms. Operations owns permissions and handling of sensitive runtime
|
||||||
artifacts. Troubleshooting owns safe diagnostic and remediation guidance.
|
artifacts. Internal docs own implementation mechanisms only.
|
||||||
Internal docs own implementation mechanisms only.
|
|
||||||
|
|
||||||
## Architecture Decision Records
|
## Architecture Decision Records
|
||||||
|
|
||||||
@@ -144,8 +153,15 @@ Use sequentially numbered ADR filenames such as
|
|||||||
|
|
||||||
Treat the decision content of an accepted ADR as immutable. When a decision
|
Treat the decision content of an accepted ADR as immutable. When a decision
|
||||||
changes, create a new ADR and update the earlier ADR's status to superseded.
|
changes, create a new ADR and update the earlier ADR's status to superseded.
|
||||||
Rejected architectural alternatives belong in the ADR; rejected product ideas
|
|
||||||
belong in the roadmap.
|
ADRs should be reserved for major architectural decisions, such as ownership
|
||||||
|
boundaries, large-scale architectural features, or invariants that rise to
|
||||||
|
the level of architectural significance. Routine choices, implementation
|
||||||
|
decisions, and rejected suggestions do not warrant an ADR unless they
|
||||||
|
otherwise represent a significant architectural decision.
|
||||||
|
|
||||||
|
Roadmaps should preserve plausible future work, not rejected product
|
||||||
|
ideas.
|
||||||
|
|
||||||
## Maintenance
|
## Maintenance
|
||||||
|
|
||||||
|
|||||||
27
docs/policy/meta.md
Normal file
27
docs/policy/meta.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Policy Set Provenance
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.0
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/meta.md
|
||||||
|
|
||||||
|
## Origin And Local Authority
|
||||||
|
|
||||||
|
This repository's policy set is adapted from
|
||||||
|
[Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy).
|
||||||
|
The adopted local policies govern work in this repository. Upstream revisions
|
||||||
|
become local policy through deliberate adoption, preserving local decisions.
|
||||||
|
Each policy's `Upstream Source` identifies its adopted baseline.
|
||||||
|
|
||||||
|
## Adoption And Updates
|
||||||
|
|
||||||
|
For policy adoption, upstream revision reviews, and updates, consult the
|
||||||
|
[upstream adoption and update guide](https://gitea.maximumdirect.net/eric/policy/src/branch/main/docs/adoption.md).
|
||||||
|
That guide and the reference example collection are maintained upstream and
|
||||||
|
accessed through links. Keep discovery links pointed at the current upstream
|
||||||
|
project and guide; keep adopted-source and example links pinned to commits.
|
||||||
|
|
||||||
|
The local [developer guide](../development.md) routes tasks to applicable
|
||||||
|
policies. Formal credit and licensing notices for the copied policy material
|
||||||
|
belong in the local [attribution document](../oss/attribution.md).
|
||||||
225
docs/policy/oss.md
Normal file
225
docs/policy/oss.md
Normal file
@@ -0,0 +1,225 @@
|
|||||||
|
# Open Source Licensing And Attribution Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.9
|
||||||
|
|
||||||
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/oss.md
|
||||||
|
|
||||||
|
## Purpose And Scope
|
||||||
|
|
||||||
|
This policy defines project licensing conventions and a repeatable House Format
|
||||||
|
for upstream attribution and license notices. It covers the project's own code
|
||||||
|
and upstream components incorporated into or distributed with the application
|
||||||
|
or library, including relevant transitive dependencies and copied code,
|
||||||
|
documentation, or assets.
|
||||||
|
Determine treatment from the component's terms and actual use.
|
||||||
|
|
||||||
|
Consulting development guidance or using tooling alone does not require an
|
||||||
|
attribution entry. Copying or adapting documentation for inclusion in the
|
||||||
|
repository is different: preserve its applicable attribution and license terms.
|
||||||
|
A material's role as development guidance does not exempt copied documents.
|
||||||
|
Apply any express permissions for attribution-free reuse of example formatting.
|
||||||
|
|
||||||
|
The baseline is a publicly available source repository with releases published
|
||||||
|
alongside it. The format is independent of language, forge, and build system.
|
||||||
|
It does not require attribution for every development tool, establish license
|
||||||
|
compatibility, or resolve every obligation arising from use or distribution.
|
||||||
|
|
||||||
|
## Canonical Locations
|
||||||
|
|
||||||
|
The [documentation policy](documentation.md) assigns ownership:
|
||||||
|
|
||||||
|
- `COPYRIGHT`: project name, copyright statements, SPDX expression, grant,
|
||||||
|
warranty disclaimer, and third-party statement.
|
||||||
|
- `LICENSE` contains the complete, unmodified project license text, including
|
||||||
|
incorporated companion text. Dependency attribution does not relicense the project.
|
||||||
|
- `docs/oss/attribution.md`: canonical component entries.
|
||||||
|
- `docs/oss/licenses/`: complete, verbatim standard and applicable companion texts.
|
||||||
|
|
||||||
|
Use recognizable license filenames, such as `Apache-2.0.txt` or `LGPL-3.0.txt`.
|
||||||
|
A shared standard text may serve multiple entries. Keep explanations outside
|
||||||
|
license texts and preserve distinct versions and exceptions.
|
||||||
|
|
||||||
|
## Narratio Licensing Scope
|
||||||
|
|
||||||
|
Narratio application code remains GPL-3.0-or-later under its existing
|
||||||
|
[COPYRIGHT](../../COPYRIGHT) and [LICENSE](../../LICENSE). Its source and release
|
||||||
|
artifacts are hosted on Gitea; separately installed subprocess applications are
|
||||||
|
not incorporated merely because Narratio invokes them. The
|
||||||
|
[release procedure](../release.md) owns publication mechanics. Policy documents
|
||||||
|
adapted from Standard Repository Policies retain CC-BY-SA-4.0 under the distinct
|
||||||
|
scope recorded in COPYRIGHT and [attribution](../oss/attribution.md).
|
||||||
|
|
||||||
|
## Upstream Reference Examples
|
||||||
|
|
||||||
|
Use the commit-pinned upstream examples to create actual project notices.
|
||||||
|
Retain their links and keep the example collection upstream; keep applicable
|
||||||
|
license texts locally as specified above.
|
||||||
|
|
||||||
|
## Project Licensing
|
||||||
|
|
||||||
|
Unless the author specifies otherwise, use **GPL version 3 or later**
|
||||||
|
(`GPL-3.0-or-later`) for applications and **LGPL version 3 or later**
|
||||||
|
(`LGPL-3.0-or-later`) for libraries. An author's explicit choice takes precedence:
|
||||||
|
for example, a one-off script may use MIT. Such a choice requires no exception
|
||||||
|
rationale, additional approval, or compensating controls under this policy.
|
||||||
|
|
||||||
|
These defaults guide new license selection. Adopting this policy does not
|
||||||
|
relicense existing code or override third-party terms. Preserve an existing
|
||||||
|
license unless the author deliberately changes it. For mixed-purpose projects,
|
||||||
|
follow the author's selected scope rather than inferring different licenses for
|
||||||
|
individual packages.
|
||||||
|
|
||||||
|
Use the upstream [application COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/application/COPYRIGHT)
|
||||||
|
or [library COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/library/COPYRIGHT)
|
||||||
|
to create the project’s root `COPYRIGHT` file.
|
||||||
|
Use the COPYRIGHT examples exactly as provided, except for placeholder
|
||||||
|
substitutions and changes expressly required or authorized by this policy or
|
||||||
|
the author.
|
||||||
|
Use verified project names, contribution years, and copyright holders.
|
||||||
|
For another selected license, adapt the grant, SPDX expression, disclaimer, and
|
||||||
|
text references together to reflect the author's selected grant.
|
||||||
|
|
||||||
|
For GPLv3 projects, copy the complete GPLv3 text into `LICENSE`. For LGPLv3
|
||||||
|
projects, place the complete LGPLv3 text followed by the complete GPLv3 text in
|
||||||
|
`LICENSE`; the LGPL incorporates the GPL terms. Keep the texts unmodified and
|
||||||
|
place project-specific statements in `COPYRIGHT`. For the default grants, the
|
||||||
|
grant and SPDX expression in `COPYRIGHT` must expressly identify `or-later`;
|
||||||
|
follow the author’s choice if a different grant is selected.
|
||||||
|
|
||||||
|
For other licenses, provide their complete text and any required project-specific
|
||||||
|
fields; the standard reference collection remains unchanged. Keep `COPYRIGHT`,
|
||||||
|
`LICENSE`, SPDX expressions, and README descriptions consistent with the actual
|
||||||
|
grant. This convention introduces no blanket requirement for per-file headers;
|
||||||
|
preserve notices or add them where the applicable terms require them.
|
||||||
|
|
||||||
|
Identify separately licensed documentation or assets in the project grant, with
|
||||||
|
links to their attribution and license information. An application's default
|
||||||
|
code license does not override the terms of incorporated documentation.
|
||||||
|
|
||||||
|
## Upstream Attribution House Format
|
||||||
|
|
||||||
|
Begin `docs/oss/attribution.md` with `# Open Source Attribution Notices`,
|
||||||
|
followed directly by component entries. These comprise the complete document.
|
||||||
|
|
||||||
|
Each entry presents these five fields in order, with blank lines between them:
|
||||||
|
|
||||||
|
1. **Project name** as a level-two heading. An optional identification paragraph
|
||||||
|
may follow, such as `Selected module: MODULE at VERSION.` with the module and
|
||||||
|
version in backticks. For copied documentation, a concise `Material:` sentence
|
||||||
|
may identify the affected files and whether they were adapted or copied
|
||||||
|
without modification. A factual qualifier such as `(transitive dependency)`
|
||||||
|
is permitted. Limit optional identification prose to factual component and
|
||||||
|
material scope.
|
||||||
|
2. **Upstream copyright statement or statements**, preserving their wording.
|
||||||
|
Put multiple statements in separate paragraphs. Include this field when the
|
||||||
|
selected upstream source supplies an applicable statement; otherwise, omit it.
|
||||||
|
3. **SPDX license identifier or expression**, when applicable, using
|
||||||
|
`SPDX-License-Identifier: EXPRESSION`.
|
||||||
|
4. **License and notice links**, beginning `License and notices:`, separated
|
||||||
|
by ` | `, and ending with a period. Label local standard texts by license
|
||||||
|
name, such as `MIT` or `Apache 2.0`. Label upstream files by their actual
|
||||||
|
filenames, such as `COPYRIGHT`, `LICENSE`, `NOTICE`, or `PATENTS`.
|
||||||
|
5. **Source repository link**, rendered exactly as `[Source](COMMIT_URL).`.
|
||||||
|
|
||||||
|
Use the upstream [attribution example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/attribution.md)
|
||||||
|
to create the project’s `docs/oss/attribution.md`.
|
||||||
|
The example illustrates omitted fields and multiple copyrights and licenses.
|
||||||
|
Replace the uppercase placeholders and illustrative URLs with actual component
|
||||||
|
information. Local license links are relative to the destination
|
||||||
|
`docs/oss/attribution.md`; copy the applicable texts into its `licenses/`
|
||||||
|
directory. Do not copy example entries for components the project does not use.
|
||||||
|
|
||||||
|
These are five fields, not a line limit. Omit the SPDX field when no applicable
|
||||||
|
identifier exists; identify nonstandard terms through the linked text. Preserve
|
||||||
|
licensing alternatives and exceptions, and record a selected option when
|
||||||
|
relevant through the factual license identification. Do not invent an identifier
|
||||||
|
or silently resolve an unsettled licensing choice.
|
||||||
|
|
||||||
|
Keep entries factual. Do not add agent-authored explanations of license
|
||||||
|
expressions, file-level license scope, research performed, retained source
|
||||||
|
notices, or compliance conclusions. Avoid filler such as "none is invented
|
||||||
|
here" and embellished link labels such as "upstream LICENSE", "additional
|
||||||
|
patent grant", or "at the imported commit". Preserve actual required upstream
|
||||||
|
content; this rule excludes editorial additions, not required notices. Policy
|
||||||
|
interpretation and exception reasoning belong in the adopted OSS policy or an
|
||||||
|
appropriate decision record, not the attribution document.
|
||||||
|
|
||||||
|
## License Texts And Upstream Links
|
||||||
|
|
||||||
|
Link standard license texts to their local copies. Link project-specific
|
||||||
|
notices to their upstream copies. Every upstream repository or notice link must
|
||||||
|
identify the exact commit corresponding to the
|
||||||
|
imported version, including the selected source revision for copied material.
|
||||||
|
|
||||||
|
Classify material according to its contents. An upstream `LICENSE`,
|
||||||
|
`COPYING`, or similar file may contain project-specific notices or exceptions
|
||||||
|
in addition to standard wording. Link both the local standard text and the
|
||||||
|
commit-specific upstream file when needed. Make companion license texts directly
|
||||||
|
reachable from the entry.
|
||||||
|
|
||||||
|
For project-specific license and attribution material, this policy accepts
|
||||||
|
direct links to the applicable upstream texts as satisfying reproduction,
|
||||||
|
inclusion, or copy requirements. This is the adopted house interpretation.
|
||||||
|
Agents must apply it without adding local-copy requirements or seeking repeated
|
||||||
|
approval solely because a license uses those terms.
|
||||||
|
|
||||||
|
This interpretation concerns notice reproduction. Concrete obligations such as
|
||||||
|
marking modified files or supplying corresponding source receive their own
|
||||||
|
applicable treatment. Preserve required notices already present in incorporated
|
||||||
|
source files; the central attribution entry does not authorize stripping them.
|
||||||
|
|
||||||
|
## Discoverability
|
||||||
|
|
||||||
|
End the project's README with two friendly statements linking to its actual
|
||||||
|
grant in `COPYRIGHT` and the attribution document. For example, for a project
|
||||||
|
with the stated license:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
PROJECT_NAME is licensed under the [LGPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
```
|
||||||
|
|
||||||
|
Each new checked-in release document and its hosted download page must end
|
||||||
|
with links whose visible text is `COPYRIGHT | LICENSE | ATTRIBUTION`. Use absolute
|
||||||
|
URLs to those files at the release's immutable tag or corresponding immutable source
|
||||||
|
revision so the links work in both locations. This release navigation is distinct
|
||||||
|
from upstream component links, which must use the imported commit.
|
||||||
|
|
||||||
|
Reuse the checked-in release document as the hosted release body where supported.
|
||||||
|
The release procedure owns concrete URLs and publication mechanics for delivering
|
||||||
|
the links through the selected channel. Do not maintain duplicate notice lists.
|
||||||
|
These conventions do not by themselves require separate downloadable license
|
||||||
|
assets, source bundles, or a different binary package format.
|
||||||
|
|
||||||
|
## Maintenance And Exceptions
|
||||||
|
|
||||||
|
Update project licensing statements together when the author changes the grant
|
||||||
|
or its scope. Update upstream notices in the change that adds, removes, upgrades,
|
||||||
|
copies, or changes the distribution of a relevant component. Check the selected source's license
|
||||||
|
and notices rather than assuming they are unchanged. Update affected entries,
|
||||||
|
commit links, and texts; retain historical versions through Git.
|
||||||
|
|
||||||
|
Check affected statements, faithful standard-text copies, and link destinations
|
||||||
|
as part of ordinary change review. For a future release tag, check intended file
|
||||||
|
paths against the candidate source; the tag need not resolve remotely before
|
||||||
|
publication. Do not add publication-time network checks, CI polling, recurring
|
||||||
|
legal sign-offs, mandatory scanners, or a full software bill of materials merely
|
||||||
|
to implement this policy.
|
||||||
|
|
||||||
|
Use the House Format routinely. Raise an exception only for a concrete obligation
|
||||||
|
or unresolved rights question it does not address, including any arising from a
|
||||||
|
particular distribution channel. Record the issue and selected treatment in the
|
||||||
|
adopted OSS policy or an appropriate decision record. Attribution entries
|
||||||
|
contain the resulting factual identification and required material, without
|
||||||
|
repeating that reasoning. Resolve the issue before the affected use or
|
||||||
|
distribution without reopening settled choices.
|
||||||
|
Common ownership of projects is neither required nor a blanket exception.
|
||||||
|
|
||||||
|
Apply the formatting convention prospectively. Do not rewrite published tags,
|
||||||
|
notes, binaries, or checksums to retrofit it. Address actual omissions deliberately
|
||||||
|
under the applicable terms and the [release correction policy](release.md#immutability-and-failure-recovery).
|
||||||
|
Ordinary attribution maintenance and release links are preparation work, not new
|
||||||
|
release approval gates.
|
||||||
@@ -1,221 +1,259 @@
|
|||||||
# Release Policy
|
# Release Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.7
|
||||||
|
|
||||||
**Last Updated**: 2026-09-25
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/release.md
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
This policy defines the minimum requirements for selecting, validating,
|
This policy defines a proportionate workflow for validating and publishing an
|
||||||
publishing, verifying, and correcting releases. Its goal is to make every
|
intended source revision under a fresh version. Releases should require little
|
||||||
release intentional, reproducible from an exact source revision, documented
|
routine intervention, avoid repeated work, and preserve published contents.
|
||||||
for consumers, and safe from retrospective replacement.
|
|
||||||
|
|
||||||
The repository-specific commands that implement these requirements belong in
|
Adopt stronger verification or reproducibility requirements through an explicit
|
||||||
`docs/release.md`. Historical release summaries belong in `docs/releases/`.
|
project-specific decision justified by the intended audience and support needs.
|
||||||
Neither document may weaken this policy, including its explicit repository
|
|
||||||
exceptions.
|
|
||||||
|
|
||||||
## Release Model
|
The repository-specific commands belong in `docs/release.md`. Historical release
|
||||||
|
summaries belong in `docs/releases/`. The procedure must agree with the adopted
|
||||||
|
policy and link to it rather than introduce additional release requirements.
|
||||||
|
|
||||||
A release consists of:
|
## Release Model And Completion
|
||||||
|
|
||||||
- one exact source commit reachable from the repository's primary branch;
|
A source release identifies one exact committed source revision through an
|
||||||
- one immutable version tag identifying that commit;
|
immutable version tag and a version-matched, checked-in release note. The
|
||||||
- one version-matched, checked-in release note; and
|
primary release branch is `main` unless the adopted policy specifies otherwise.
|
||||||
- every artifact, image, package, registry entry, or other deliverable the
|
The procedure must name the authoritative publication remote.
|
||||||
repository declares for that release.
|
|
||||||
|
|
||||||
The repository's primary branch is `main` unless an adopted policy documents
|
A successful push of the intended tag, with its source commit available on the
|
||||||
an exception. A release candidate must be committed and pushed to that branch
|
authoritative primary branch, completes the release. The source commit may be
|
||||||
before its release tag is published.
|
pushed before the tag or published together with it through an atomic push.
|
||||||
|
The procedure must choose and document the supported approach.
|
||||||
|
|
||||||
The source tag is the authoritative release identity. Published deliverables
|
Release commands must finish at successful publication. They must not wait for
|
||||||
must be traceable to the tagged source and must agree with its version. A
|
or poll CI, require successful CI status, inspect downloadable artifacts, or
|
||||||
repository may publish source only. When it publishes additional deliverables,
|
check consumer installation or Go module availability as completion gates.
|
||||||
its release procedure must enumerate them and define how each is built,
|
A failed or ambiguous push requires resolving the authoritative remote state
|
||||||
identified, published, and verified.
|
before declaring success or retrying; successful pushes do not require a
|
||||||
|
separate remote read-back gate.
|
||||||
|
|
||||||
Release automation may validate or publish a release only when its exact
|
Repositories may publish source only. Additional binaries, images, packages,
|
||||||
responsibility is documented. Automation must not silently change the source
|
checksums, or other declared deliverables may be published asynchronously from
|
||||||
candidate, move a published tag, replace a published deliverable, or repair a
|
the tagged source. The procedure must identify those deliverables and the
|
||||||
release in place.
|
responsibility of their automation. Published deliverables must be traceable
|
||||||
|
to that source and identify the same version.
|
||||||
|
|
||||||
|
Track source-release completion and artifact delivery separately. Report delivery
|
||||||
|
failures and optional investigations under artifact-delivery status.
|
||||||
|
|
||||||
## Versioning And Compatibility
|
## Versioning And Compatibility
|
||||||
|
|
||||||
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
||||||
no leading zeroes. Each version must be unused locally and in every configured
|
no leading zeroes. Prereleases require an explicit adopted policy defining
|
||||||
remote or publication channel before publication begins.
|
their format and use.
|
||||||
|
|
||||||
Unless an adopted policy explicitly supports and defines prereleases,
|
The selected version must be unused locally and on the authoritative remote.
|
||||||
prerelease versions are not permitted.
|
Do not require queries to every configured remote or publication service.
|
||||||
|
A version known to have already been published must not be reused, even if the
|
||||||
|
normal guards do not inspect that channel. Adding a distribution channel
|
||||||
|
requires a deliberate update to the policy and procedure where needed.
|
||||||
|
|
||||||
For releases at or after `v1.0.0`:
|
For releases at or after `v1.0.0`:
|
||||||
|
|
||||||
- a major release may make intentional incompatible changes;
|
- a major release may make intentional incompatible changes;
|
||||||
- a minor release may add backward-compatible behavior; and
|
- a minor release may add backward-compatible behavior or raise the Go consumer
|
||||||
|
minimum as described below; and
|
||||||
- a patch release may make backward-compatible fixes.
|
- a patch release may make backward-compatible fixes.
|
||||||
|
|
||||||
|
In this context, "backward-compatible" means only that pre-existing, valid
|
||||||
|
configurations will continue to work following the release. Behavior need not
|
||||||
|
remain strictly identical.
|
||||||
|
|
||||||
Before `v1.0.0`, a minor release may change a documented public, operational,
|
Before `v1.0.0`, a minor release may change a documented public, operational,
|
||||||
configuration, data, integration, or compatibility contract when the release
|
configuration, data, integration, or compatibility contract when the release
|
||||||
note explains the impact and required consumer action. A patch release must
|
note explains the impact and required consumer action. A patch release must
|
||||||
not intentionally break those contracts within its minor line.
|
not intentionally break those contracts within its minor line.
|
||||||
|
|
||||||
A repository with additional compatibility promises must define them in its
|
Additional compatibility promises and deliberate exceptions belong in the
|
||||||
adopted policy or canonical contract documentation. A release note may explain
|
adopted policy or canonical contract documentation. Release notes explain
|
||||||
a compatibility change, but it must not redefine the current compatibility
|
changes; they do not redefine current compatibility contracts.
|
||||||
contract.
|
|
||||||
|
|
||||||
## Release Documentation
|
## Consumer Minimum And Release Toolchain
|
||||||
|
|
||||||
Every release made under this policy must include
|
Distinguish the minimum toolchain supported for consumers from the toolchain
|
||||||
`docs/releases/<version>.md` in the tagged source tree. The filename must use
|
maintainers use to build and validate a release. Record the consumer minimum in
|
||||||
the complete version tag, and the document must begin with a title containing
|
the language's standard metadata and explain its support meaning in canonical
|
||||||
the product name and that exact version.
|
documentation. Define the selected release toolchain and its setup commands in
|
||||||
|
`docs/release.md`. Toolchain selection and upgrade cadence are repository-specific
|
||||||
|
choices.
|
||||||
|
|
||||||
Every new release note must contain these sections:
|
For Go repositories, normally declare the initial stable release of the selected
|
||||||
|
series as the consumer minimum, such as `go 1.26.0`. Use a higher patch minimum
|
||||||
|
when a dependency or an identified correctness fix requires it, and document
|
||||||
|
the reason.
|
||||||
|
|
||||||
```markdown
|
For release-policy purposes, successful build and release validation on the
|
||||||
# <Product> vMAJOR.MINOR.PATCH
|
selected Go patch release are sufficient to presume support across that Go
|
||||||
|
series, subject to the declared consumer minimum and concrete evidence of
|
||||||
|
incompatibility. Investigate specific compatibility concerns as they arise.
|
||||||
|
|
||||||
This release ...
|
Use the selected release toolchain for candidate validation and release builds,
|
||||||
|
including CI jobs performing those tasks. A newer validation patch version alone
|
||||||
|
leaves the consumer minimum unchanged.
|
||||||
|
|
||||||
## Summary
|
A minor release may raise the Go consumer minimum, including from one Go series
|
||||||
|
to the next, both before and after `v1.0.0`. This is an explicit exception to the
|
||||||
|
backward-compatibility requirement for minor releases. Patch releases preserve
|
||||||
|
the consumer minimum. Explain an increase's impact and required consumer action
|
||||||
|
in the release note. Other incompatible changes remain subject to the versioning
|
||||||
|
rules above.
|
||||||
|
|
||||||
## Compatibility
|
## Release Documentation And Preparation
|
||||||
|
|
||||||
## Upgrade
|
Every new release must include `docs/releases/<version>.md` in the tagged
|
||||||
|
source tree. Use the complete version tag as the filename and begin with a
|
||||||
|
title containing the product name and that exact version.
|
||||||
|
|
||||||
## Changes
|
Include a short summary and any relevant compatibility impact or upgrade
|
||||||
```
|
instructions. Choose sections suited to the release and keep the note
|
||||||
|
proportionate to the change.
|
||||||
|
|
||||||
Use an explicit statement such as "No action required" when a section has no
|
Keep exact current contracts in their canonical documents and update affected
|
||||||
substantive content.
|
documentation with the behavior change. Link to those documents from the note
|
||||||
|
where useful. If annotated tags are used, derive their summary from the
|
||||||
|
checked-in note.
|
||||||
|
|
||||||
Release notes are immutable historical summaries. They should link to current
|
Include the release footer defined by the [OSS policy](oss.md#discoverability)
|
||||||
canonical documentation for exact behavior. Every affected canonical document
|
in each new release document and preserve it on the hosted download page. The
|
||||||
must be updated in the same candidate; a release note must not substitute for
|
release procedure defines the concrete URLs and publication mechanics. Prepare
|
||||||
current documentation or defer required documentation changes.
|
these links with the release note; they do not add a network check or approval
|
||||||
|
gate.
|
||||||
|
|
||||||
## Candidate Preparation And Validation
|
Handle version selection, release-note content, and retirement of completed
|
||||||
|
roadmaps during preparation. Preserve planned and deferred work and repair
|
||||||
|
affected links when retiring roadmaps. Reuse ordinary change review for
|
||||||
|
unintended files, credentials, and private data. Scope release-content review
|
||||||
|
to the tagged source.
|
||||||
|
|
||||||
Each repository must provide one documented release-check command or script
|
## Candidate Validation
|
||||||
that exercises the complete set of automated source-candidate gates. The
|
|
||||||
repository-specific procedure must state all additional manual gates.
|
|
||||||
|
|
||||||
The required gates are:
|
Provide one publication command that validates the final committed candidate,
|
||||||
|
checks publication state, and publishes the intended refs. A validation-only
|
||||||
|
mode or command may be provided for diagnosis, but must not be a required step
|
||||||
|
before publication repeats the same checks.
|
||||||
|
|
||||||
- dependency or module hygiene appropriate to the language and ecosystem;
|
Run the complete deterministic, offline default test suite once for the final
|
||||||
- the complete deterministic, offline default test suite;
|
candidate, following the [testing policy](testing.md). For repositories that
|
||||||
- static analysis and linting used by the repository;
|
publish builds, verify the required build targets. Select those targets for
|
||||||
- formatting and whitespace checks;
|
the application's actual support commitments; native testing on each platform
|
||||||
- validation of maintained examples, configuration, schemas, generated
|
and access to particular hardware are not default release prerequisites.
|
||||||
sources, and documentation commands where applicable;
|
|
||||||
- review of changed local documentation links;
|
Additional gates must address a concrete risk that the existing checks do not
|
||||||
- removal of obsolete roadmap documents under `docs/roadmap/` that describe
|
adequately cover. Do not automatically require linting, race testing, module
|
||||||
completed work included in the release; and
|
hygiene audits, documentation audits, credential scans, example validation, or
|
||||||
- review for unintended files, generated output, credentials, private data,
|
expanded platform matrices solely because they are possible. Retain such
|
||||||
and unrelated changes.
|
checks when their distinct protection justifies their cost. A one-time migration
|
||||||
|
check must not silently become a permanent release requirement.
|
||||||
|
|
||||||
|
Release tests must not require real credentials, mutable application services,
|
||||||
|
paid APIs, provider probes, or inference calls. The procedure may describe dependency
|
||||||
|
preparation separately from offline validation.
|
||||||
|
|
||||||
|
Avoid duplicate validation across release phases. Successful checks for the
|
||||||
|
same final candidate need not be repeated solely to satisfy another phase;
|
||||||
|
any reuse must clearly apply to that exact candidate. Persistent validation
|
||||||
|
caches are not required. If the candidate changes, validate the new candidate.
|
||||||
|
Cheap publication-state checks may be repeated immediately before pushing
|
||||||
|
because local or remote state may have changed during validation.
|
||||||
|
|
||||||
|
Automate mechanical guards. Human review gates are strongly disfavored: add one
|
||||||
|
only through an explicit project-specific policy decision explaining the
|
||||||
|
concrete risk and why ordinary change review or automation is insufficient.
|
||||||
|
Do not add routine confirmations for checks the command can perform itself.
|
||||||
|
|
||||||
|
## Narratio Candidate Checks
|
||||||
|
|
||||||
|
Narratio's candidate checker adds the following checks to the one full,
|
||||||
|
race-enabled offline suite:
|
||||||
|
|
||||||
|
- `go mod tidy -diff` detects an incomplete checked-in module graph without
|
||||||
|
changing source.
|
||||||
|
- Tracked Go formatting and diff whitespace checks catch inexpensive source
|
||||||
|
hygiene defects before publication.
|
||||||
|
- Race instrumentation adds distinct coverage for concurrent I/O,
|
||||||
|
cancellation, and shared state.
|
||||||
|
- `go vet ./...` detects static issues not established by runtime tests.
|
||||||
|
- The asset builder verifies the declared Linux amd64, Linux arm64, and
|
||||||
|
best-effort macOS arm64 binaries and checks the embedded version on the host.
|
||||||
|
|
||||||
|
The checker uses `GOWORK=off` and readonly module mode for tests, vet, and
|
||||||
|
builds. Versioned module replacements are allowed; filesystem replacements
|
||||||
|
are not release inputs. Workspace and vendor files are not prohibited solely
|
||||||
|
by their presence.
|
||||||
|
|
||||||
## Publication Guards
|
## Publication Guards
|
||||||
|
|
||||||
Immediately before publication, the maintainer or release automation must
|
Automate the checks needed to publish the intended source under a fresh version:
|
||||||
fetch the current primary branch and tags from the authoritative remote and
|
|
||||||
verify all of the following:
|
|
||||||
|
|
||||||
- the version has the required format and is not already published;
|
- the version has the adopted format and is unused locally and on the
|
||||||
- the current branch is the primary release branch;
|
authoritative remote;
|
||||||
- the worktree and index are clean;
|
- the worktree and index are clean on the primary release branch;
|
||||||
- the current commit is the recorded, validated candidate;
|
- the source being published is the exact candidate that passed validation,
|
||||||
- the authoritative remote branch points to that same commit;
|
including its matching release note;
|
||||||
- the matching release note exists in that commit and has the required title
|
- the remote primary branch already identifies that candidate, or an atomic
|
||||||
and sections;
|
source/tag push will advance it to that candidate without discarding remote
|
||||||
- all required approvals and automated gates succeeded for that commit; and
|
history; and
|
||||||
- no local or remote tag already uses the selected version.
|
- the tag identifies the validated candidate and only the intended refs are
|
||||||
|
published.
|
||||||
|
|
||||||
Create the version tag against the guarded commit and verify its target before
|
Fetch the authoritative branch and tag state as needed for these checks.
|
||||||
publishing it. Publish only the exact intended ref and deliverables. Broad
|
Do not force branch or tag updates to bypass a failed guard. Publish explicit
|
||||||
operations such as `git push --tags` are discouraged because they can publish
|
refs rather than all local tags. Do not require CI success, publication-service
|
||||||
unreviewed refs unrelated to the release.
|
availability checks, or a separate manual confirmation for each guard.
|
||||||
|
|
||||||
The repository-specific procedure must make these guards executable or give
|
## Immutability And Failure Recovery
|
||||||
copyable commands for performing them.
|
|
||||||
|
|
||||||
## Immutability And Correction
|
Published version tags and published contents are immutable. Do not move,
|
||||||
|
overwrite, recreate, or delete a published tag, or replace a published artifact,
|
||||||
|
checksum, signature, provenance statement, or release note under that version.
|
||||||
|
The checked-in note at the immutable tag is that release's historical record.
|
||||||
|
|
||||||
Published version tags and published deliverables are immutable. Do not move,
|
If validation fails before publication, correct and commit the candidate and
|
||||||
overwrite, recreate, or delete a published tag. Do not replace an artifact,
|
rerun the publication command. If a push fails or its outcome is ambiguous,
|
||||||
image, package, checksum, signature, provenance statement, or release note
|
inspect the authoritative remote before retrying. Remove an unpublished local
|
||||||
under an already published version.
|
tag only after confirming it was never published or used by a release channel.
|
||||||
|
An unavailable remote leaves publication status unknown; do not overwrite a tag
|
||||||
|
to resolve uncertainty.
|
||||||
|
|
||||||
If validation fails before publication, correct the candidate, rerun the
|
Transient network, authentication, CI, or consumer-availability failures do not
|
||||||
complete gates, and repeat the publication guards. An unpublished local tag
|
by themselves require a new version. Asynchronous delivery may be retried from
|
||||||
may be removed after confirming that it was never published or used by a
|
the same immutable tag. Missing artifacts may be published later, provided
|
||||||
release channel.
|
existing published contents are not replaced and the additions remain consistent
|
||||||
|
with the tagged source and any already-published checksum manifest. If that
|
||||||
|
cannot be achieved, publish a new version.
|
||||||
|
|
||||||
If publication or post-publication verification reveals a defect, leave the
|
A defect requiring changes to published source or contents requires a corrected
|
||||||
published release intact. Correct the defect on the primary branch, choose a
|
commit, a new semantically appropriate version, a matching release note, and
|
||||||
new patch version or other semantically appropriate new version, write a new
|
the release procedure again. Leave the original release intact. A channel's
|
||||||
matching release note, and perform the complete release procedure again.
|
yank, deprecation, or advisory mechanism may warn consumers away from a defective
|
||||||
|
release without replacing its contents or reusing its version.
|
||||||
A distribution channel's supported yank, deprecation, or advisory mechanism
|
|
||||||
may warn consumers away from a defective release, but it must not replace that
|
|
||||||
release's contents or reuse its version.
|
|
||||||
|
|
||||||
## Repository Release Procedure
|
## Repository Release Procedure
|
||||||
|
|
||||||
Every adopting repository must maintain `docs/release.md` as the canonical
|
Maintain `docs/release.md` as a short, executable maintainer runbook. It must
|
||||||
maintainer runbook for implementing this policy. It must define, in execution
|
identify:
|
||||||
order:
|
|
||||||
|
|
||||||
1. maintainer prerequisites and required access;
|
1. prerequisites, selected release toolchain, primary branch, and authoritative
|
||||||
2. version selection and compatibility review;
|
remote;
|
||||||
3. release-note creation;
|
2. version and release-note preparation;
|
||||||
4. candidate preparation and the complete validation command;
|
3. one publication command with its selected local checks and automated guards;
|
||||||
5. candidate commit, push, and exact commit recording;
|
4. declared deliverables, required build targets, and automation responsibilities;
|
||||||
6. publication guards;
|
5. the successful-push completion point and separately reported delivery status;
|
||||||
7. exact tag and deliverable publication commands;
|
and
|
||||||
8. authoritative remote and consumer-facing verification; and
|
6. failure handling, ambiguous-push recovery, and asynchronous delivery retries.
|
||||||
9. failure handling and correction.
|
|
||||||
|
|
||||||
The procedure should use copyable, fail-fast commands where practical. It must
|
Use copyable commands where practical. Keep optional diagnostics and consumer
|
||||||
name the primary branch, authoritative remote, tag form, published
|
verification clearly optional. The procedure must not turn preparation work,
|
||||||
deliverables, supported build targets, release automation responsibilities,
|
ordinary change review, or post-publication investigation into additional
|
||||||
and consumer verification path. It must link to this policy instead of
|
release gates.
|
||||||
restating or redefining its requirements.
|
|
||||||
|
|
||||||
## Policy Exceptions
|
|
||||||
|
|
||||||
### Tag-push completion and asynchronous deliverables
|
|
||||||
|
|
||||||
Narratio's automated release responsibility ends when the exact intended tag is
|
|
||||||
successfully pushed to `origin`. It must not wait for, poll, or check CI/Gitea
|
|
||||||
results, download assets, or verify their checksums as a completion condition.
|
|
||||||
Binary and checksum publication is asynchronous; consumer-facing inspection is
|
|
||||||
optional follow-up, not a gate on the source release.
|
|
||||||
|
|
||||||
This deliberately qualifies the base policy's complete-deliverable and
|
|
||||||
post-publication verification requirements. CI reliability is outside the
|
|
||||||
release command's scope; an unavailable publication service must not cause an
|
|
||||||
automated releaser to wait indefinitely or claim to repair a published version.
|
|
||||||
|
|
||||||
Compensating controls are complete local candidate validation (including supported
|
|
||||||
cross-builds and a host version check), exact source/tag guards, immutable source
|
|
||||||
tags, asynchronous build validation, and non-overwriting asset publication.
|
|
||||||
Successful tag publication is not evidence that binary assets are available.
|
|
||||||
Optional inspection and corrective-release procedures belong in
|
|
||||||
[the release procedure](../release.md).
|
|
||||||
|
|
||||||
### Authoritative publication scope
|
|
||||||
|
|
||||||
Narratio's synchronous publication guards inspect the authoritative `origin`
|
|
||||||
remote and its `main` branch, not every configured Git remote or a Gitea release
|
|
||||||
entry. The command does not add release-service or registry availability checks.
|
|
||||||
This qualifies the base policy's all-channel unused-version requirement.
|
|
||||||
|
|
||||||
Other remotes are not Narratio release authorities, and Gitea asset publication
|
|
||||||
is asynchronous. The compensating controls are local and origin tag uniqueness,
|
|
||||||
exact candidate matching, and the publisher's non-overwrite settings. Any known
|
|
||||||
already-published version or conflicting deliverable remains ineligible for
|
|
||||||
reuse: choose a new version rather than bypassing guards. A future additional
|
|
||||||
distribution channel requires deliberate policy/procedure updates.
|
|
||||||
|
|||||||
@@ -1,43 +1,32 @@
|
|||||||
# Testing Policy
|
# Testing Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated**: 2026-09-25
|
**Last Updated**: 2026-11-17
|
||||||
|
|
||||||
|
**Upstream Source**: https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/testing.md
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
||||||
|
|
||||||
We do not optimize for test count, line coverage, exhaustive isolation, or the fewest possible tests. We optimize for sufficient confidence in important behavior while imposing as little unnecessary friction as possible on future development.
|
We optimize for sufficient confidence in important behavior while minimizing friction on future development.
|
||||||
|
|
||||||
## Every test has a cost
|
## Every test has a cost
|
||||||
|
|
||||||
Testing is not an unqualified good. Every test imposes both an immediate cost and a continuing lifetime cost.
|
Every test has an immediate and continuing cost: writing, review, execution,
|
||||||
|
diagnosis, fixture maintenance, and updates when legitimate behavior changes.
|
||||||
A test must be:
|
Tests can also constrain refactoring, duplicate policy, and add failure noise.
|
||||||
|
|
||||||
- written and reviewed;
|
|
||||||
- understood by future maintainers and coding agents;
|
|
||||||
- executed in local and CI workflows;
|
|
||||||
- diagnosed when it fails;
|
|
||||||
- updated when legitimate behavior changes;
|
|
||||||
- maintained as fixtures, APIs, and dependencies evolve; and
|
|
||||||
- removed or rewritten when it becomes redundant, brittle, misleading, or obsolete.
|
|
||||||
|
|
||||||
Tests also create cognitive and architectural friction. They can constrain refactoring, duplicate policy, slow feedback loops, add noise to failures, and cause harmless implementation changes to require unrelated edits across the suite.
|
|
||||||
|
|
||||||
A test is warranted only when the confidence it provides justifies these costs.
|
A test is warranted only when the confidence it provides justifies these costs.
|
||||||
|
Evaluate that tradeoff at two levels:
|
||||||
Apply this cost-benefit analysis at two levels:
|
|
||||||
|
|
||||||
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
||||||
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
||||||
|
|
||||||
The preferred test suite is a **lean suite that provides sufficient confidence in the risks that matter, without redundant or low-value tests**. We seek sufficient confidence with the least unnecessary testing friction, not the fewest possible tests.
|
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. Keep ordinary internal changes inexpensive.
|
||||||
|
|
||||||
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. They should not make ordinary internal changes needlessly expensive.
|
Evaluate maintenance cost against the specific failure being protected. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
||||||
|
|
||||||
The cost of a test is not a reason to omit testing by default. Do not cite maintenance cost abstractly. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
|
||||||
|
|
||||||
## Default testing style
|
## Default testing style
|
||||||
|
|
||||||
@@ -59,7 +48,7 @@ Control clocks, randomness, environment variables, and other process-global or m
|
|||||||
|
|
||||||
## What deserves tests
|
## What deserves tests
|
||||||
|
|
||||||
Prioritize tests for:
|
To the extent the following features are present in the application, prioritize tests for:
|
||||||
|
|
||||||
1. Public and package-level contracts.
|
1. Public and package-level contracts.
|
||||||
2. Domain rules and important invariants.
|
2. Domain rules and important invariants.
|
||||||
@@ -69,15 +58,27 @@ Prioritize tests for:
|
|||||||
6. Previously observed or plausible regressions.
|
6. Previously observed or plausible regressions.
|
||||||
7. Representative integration and end-to-end workflows.
|
7. Representative integration and end-to-end workflows.
|
||||||
|
|
||||||
A package-level contract is behavior relied upon by another package or major collaborator, not every observable detail of a package implementation.
|
A package-level contract comprises behavior relied upon by another package or major collaborator.
|
||||||
|
|
||||||
For behavior involving **data integrity, destructive operations, compatibility, security, concurrency, idempotency, or recovery**, presume that durable tests are required unless the behavior is already credibly protected at another layer.
|
Choose tests for requested behavior and established contracts. Tests must not
|
||||||
|
introduce new restrictions, guarantees, or threat scenarios merely because they
|
||||||
|
could be asserted. Follow the [agent policy](agents.md) when deciding whether a
|
||||||
|
behavior belongs to the contract; current implementation behavior alone is not
|
||||||
|
sufficient authority.
|
||||||
|
|
||||||
|
For established behavior involving **data integrity, destructive operations,
|
||||||
|
compatibility, security, concurrency, idempotency, or recovery**, favor durable
|
||||||
|
tests for realistic failures whose consequences warrant protection. Identify
|
||||||
|
the failure and the existing contract it would violate. These categories call
|
||||||
|
for attention, not an automatic test inventory or permission to strengthen the
|
||||||
|
application's guarantees. Account for protection already provided at other layers.
|
||||||
|
|
||||||
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
||||||
|
|
||||||
## Choose the right test boundary
|
## Choose the right test boundary
|
||||||
|
|
||||||
Test through the narrowest stable boundary that expresses the behavior clearly.
|
Choose the narrowest stable boundary that expresses the behavior clearly and
|
||||||
|
provides durable confidence with minimal incidental coupling.
|
||||||
|
|
||||||
This is often the package API, but it may instead be:
|
This is often the package API, but it may instead be:
|
||||||
|
|
||||||
@@ -85,28 +86,15 @@ This is often the package API, but it may instead be:
|
|||||||
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
||||||
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
||||||
|
|
||||||
Do not force all behavior through oversized end-to-end tests. Do not test every private helper merely because it exists. Choose the boundary that gives durable confidence with the least incidental coupling.
|
|
||||||
|
|
||||||
## Test behavior, not implementation
|
## Test behavior, not implementation
|
||||||
|
|
||||||
A test should protect a decision, contract, or invariant—not memorialize the current implementation.
|
A test should protect a selected decision, contract, or invariant.
|
||||||
|
|
||||||
Before adding or retaining a test, ask:
|
A test is suspect when it primarily detects changes to private constants or
|
||||||
|
helpers, equivalent operation ordering, incidental formatting, equivalent
|
||||||
|
algorithms, or internal structure that preserves behavior.
|
||||||
|
|
||||||
> What realistic defect would this test catch?
|
Behavioral tests should normally remain stable through internal refactoring that preserves the contract.
|
||||||
|
|
||||||
A test is suspect when its main purpose is to detect that someone:
|
|
||||||
|
|
||||||
- changed an internal constant;
|
|
||||||
- renamed or split a private helper;
|
|
||||||
- reordered equivalent internal operations;
|
|
||||||
- changed incidental formatting;
|
|
||||||
- replaced one correct algorithm with another; or
|
|
||||||
- refactored internal object structure without changing behavior.
|
|
||||||
|
|
||||||
Refactoring should normally require no test edits unless the refactored structure is itself part of the contract.
|
|
||||||
|
|
||||||
A test can be factually correct and still have negative value. Accurately describing current behavior is not enough; the protected behavior must be important enough to justify the future friction.
|
|
||||||
|
|
||||||
## Expected effects of different changes
|
## Expected effects of different changes
|
||||||
|
|
||||||
@@ -123,12 +111,13 @@ A test failing is not the same as a test needing to be edited. Many tests may co
|
|||||||
|
|
||||||
## Separate mechanism from policy
|
## Separate mechanism from policy
|
||||||
|
|
||||||
Configurable thresholds and defaults must not be duplicated throughout the test suite.
|
Derive expectations from test-controlled configuration and relationships.
|
||||||
|
|
||||||
For example, do not encode an internal concurrency limit indirectly:
|
For this example, assume the selected contract rejects a request to start more
|
||||||
|
processes than a configured limit. Do not encode its production default indirectly:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// Production policy:
|
// Production default:
|
||||||
const maxConcurrency = 4
|
const maxConcurrency = 4
|
||||||
|
|
||||||
// Brittle test:
|
// Brittle test:
|
||||||
@@ -146,25 +135,30 @@ require.NoError(t, runner.Start(limit))
|
|||||||
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
||||||
```
|
```
|
||||||
|
|
||||||
The test should prove:
|
For this selected contract, the test should prove:
|
||||||
|
|
||||||
- the configured limit is accepted; and
|
- the configured limit is accepted; and
|
||||||
- one beyond the configured limit is rejected.
|
- one beyond the configured limit is rejected.
|
||||||
|
|
||||||
|
Rejection is not a general requirement for concurrency control. If the selected
|
||||||
|
contract queues excess work or limits active workers while accepting larger
|
||||||
|
batches, test that behavior instead. Do not add rejection or a configurable
|
||||||
|
limit solely to reproduce this example.
|
||||||
|
|
||||||
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
||||||
|
|
||||||
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior, not duplicated literals.
|
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior.
|
||||||
|
|
||||||
For concurrency limits, test both kinds of behavior when relevant:
|
For established concurrency limits, distinguish these behaviors where the contract requires them:
|
||||||
|
|
||||||
1. **Configuration enforcement:** invalid or excessive requested values are handled correctly.
|
1. **Configuration handling:** values are accepted or rejected according to the selected contract.
|
||||||
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
||||||
|
|
||||||
Use a test-controlled limit and measure the behavior relative to that limit. Do not merely assert today's default value.
|
Use a test-controlled limit and measure the behavior relative to that limit.
|
||||||
|
|
||||||
## Avoid semantic duplication across layers
|
## Assign each behavior a test owner
|
||||||
|
|
||||||
Each behavior should have a clear test owner.
|
Where these layers exist, assign ownership as follows:
|
||||||
|
|
||||||
- Parser tests own parsing cases.
|
- Parser tests own parsing cases.
|
||||||
- Validator tests own validation rules.
|
- Validator tests own validation rules.
|
||||||
@@ -174,9 +168,7 @@ Each behavior should have a clear test owner.
|
|||||||
- CLI tests own argument and configuration mapping.
|
- CLI tests own argument and configuration mapping.
|
||||||
- End-to-end tests prove that representative assembled workflows work.
|
- End-to-end tests prove that representative assembled workflows work.
|
||||||
|
|
||||||
Higher-level tests should not repeat every lower-level case. A single intentional policy change should not require unrelated edits across many test files.
|
Give each layer its distinct responsibility and keep expectation updates localized to the contract being changed.
|
||||||
|
|
||||||
Tests that are individually reasonable may still be collectively redundant. Evaluate the marginal value of each additional test in light of the protection already provided by the rest of the suite.
|
|
||||||
|
|
||||||
## Use test doubles deliberately
|
## Use test doubles deliberately
|
||||||
|
|
||||||
@@ -197,104 +189,76 @@ Mocks are appropriate when the contract includes facts such as:
|
|||||||
- an expensive API is called no more than once; or
|
- an expensive API is called no more than once; or
|
||||||
- a security audit event is emitted.
|
- a security audit event is emitted.
|
||||||
|
|
||||||
Do not use mocks merely to isolate every object or reproduce the implementation's call graph.
|
|
||||||
|
|
||||||
## Go-specific guidance
|
## Go-specific guidance
|
||||||
|
|
||||||
Use:
|
Select techniques by behavior and risk:
|
||||||
|
|
||||||
- table-driven tests for meaningful behavioral categories and boundaries;
|
- table-driven tests for meaningful behavioral categories and boundaries;
|
||||||
- `t.TempDir()` for real filesystem behavior;
|
- `t.TempDir()` for real filesystem behavior;
|
||||||
- `httptest.Server` for realistic HTTP interactions;
|
- `httptest.Server` for realistic HTTP interactions;
|
||||||
- fuzz tests for parsers, normalization, path handling, and broad input spaces;
|
- fuzz tests when exploring broad input spaces, such as parsers or path handling, adds useful protection beyond representative cases;
|
||||||
- golden files only when the complete output is intentionally stable;
|
- golden files only when the complete output is intentionally stable;
|
||||||
- integration tests where correctness depends on component interaction; and
|
- integration tests where correctness depends on component interaction; and
|
||||||
- a small number of representative end-to-end tests.
|
- a small number of representative end-to-end tests when assembled workflows expose meaningful risks not adequately covered at narrower boundaries.
|
||||||
|
|
||||||
Avoid exact error-string assertions unless the wording is itself contractual. Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields.
|
Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields. Use exact error-wording assertions only when the wording is contractual.
|
||||||
|
|
||||||
At CLI boundaries, prefer exit classifications, structured output, and the smallest stable semantic fragment needed to identify the error. Do not snapshot complete diagnostic wording unless it is contractual.
|
At CLI boundaries, prefer exit classifications, structured output, and the smallest stable semantic fragment needed to identify the error. Use complete diagnostic snapshots only when the wording is contractual.
|
||||||
|
|
||||||
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
||||||
|
|
||||||
Keep tests readable and direct. Test helpers and fixture frameworks must earn their own maintenance cost; do not build elaborate test infrastructure for small or isolated needs.
|
Keep tests readable and direct. Size test helpers and fixture frameworks to the maintenance benefit they provide.
|
||||||
|
|
||||||
## Coverage
|
## Coverage
|
||||||
|
|
||||||
Coverage is a diagnostic, not a target.
|
Use coverage to locate untested critical branches and unexpectedly weak packages. Evaluate test quality through meaningful behavioral protection and choose coverage according to risk.
|
||||||
|
|
||||||
Use it to find untested critical branches and unexpectedly weak packages. Do not write low-value tests solely to increase a percentage, and do not infer test quality from coverage alone.
|
|
||||||
|
|
||||||
Pure domain logic will often warrant higher coverage than CLI wiring or external adapters. Uneven coverage is acceptable when it reflects risk.
|
Pure domain logic will often warrant higher coverage than CLI wiring or external adapters. Uneven coverage is acceptable when it reflects risk.
|
||||||
|
|
||||||
Increasing coverage is valuable only when the newly covered behavior protects a meaningful risk at an acceptable cost.
|
|
||||||
|
|
||||||
## Regression tests
|
## Regression tests
|
||||||
|
|
||||||
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
||||||
|
|
||||||
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant; do not preserve accidental implementation details from the original bug.
|
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant.
|
||||||
|
|
||||||
Not every historical bug requires a permanent test. If the underlying design has made recurrence impossible, the test has become redundant, or a stronger invariant test now subsumes it, remove or consolidate it.
|
Remove or consolidate a test when the underlying design has made recurrence impossible, its protection is redundant, or a stronger invariant test subsumes it.
|
||||||
|
|
||||||
## Deleting or rewriting tests
|
## Deleting or rewriting tests
|
||||||
|
|
||||||
Tests are maintained code, not permanent historical artifacts.
|
Delete or rewrite tests when maintenance cost exceeds their continuing
|
||||||
|
protective value.
|
||||||
Delete or rewrite a test when its maintenance cost exceeds the confidence it provides.
|
|
||||||
|
|
||||||
Strong candidates include tests that:
|
Strong candidates include tests that:
|
||||||
|
|
||||||
- require updates after harmless internal changes;
|
- require updates after harmless internal changes;
|
||||||
- directly assert private constants without protecting a real contract;
|
- assert incidental private constants or snapshot large amounts of incidental output;
|
||||||
- duplicate the same policy across several layers;
|
|
||||||
- verify mock choreography rather than outcomes;
|
- verify mock choreography rather than outcomes;
|
||||||
- snapshot large amounts of incidental output;
|
- duplicate policy across layers, retest trivial helpers covered by package
|
||||||
- test trivial private helpers already exercised through stable package behavior;
|
behavior, or protect risks covered more effectively elsewhere;
|
||||||
- protect risks already covered more effectively elsewhere;
|
|
||||||
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
||||||
- no longer correspond to a plausible failure mode.
|
- no longer correspond to a plausible failure mode.
|
||||||
|
|
||||||
Several brittle tests may encode one genuine requirement. Replace them with one durable behavior-level or invariant test rather than preserving all of them.
|
Several brittle tests may encode one genuine requirement. Consolidate them into one durable behavior-level or invariant test.
|
||||||
|
|
||||||
Deleting a low-value test can improve the quality of the suite by reducing noise, maintenance burden, and friction around legitimate change.
|
|
||||||
|
|
||||||
## Reviewing a proposed test
|
## Reviewing a proposed test
|
||||||
|
|
||||||
Use the following questions when the value, boundary, or durability of a proposed test is not self-evident. Significant test additions should be reviewable against them, but written answers are not required for every routine test.
|
Use the following questions when a proposed test needs closer evaluation. Significant test additions should be reviewable against them; written answers are optional for routine tests.
|
||||||
|
|
||||||
1. What realistic defect would it catch?
|
1. Which requested behavior or established contract does it protect, and what realistic defect would violate it?
|
||||||
2. How likely is that defect?
|
2. How likely and consequential is that defect, and is it already protected elsewhere?
|
||||||
3. How consequential would it be?
|
3. What is the narrowest stable boundary that can test it clearly?
|
||||||
4. Is the behavior already protected elsewhere?
|
4. Would a correct internal refactor or a change to an incidental default require test edits?
|
||||||
5. At which layer should this behavior be owned?
|
5. Does its confidence justify its maintenance, execution, and diagnostic cost, or would a smaller test suffice?
|
||||||
6. Does the test assert a durable contract or an incidental implementation detail?
|
|
||||||
7. Could the implementation be refactored without changing the behavior and without editing this test?
|
|
||||||
8. What should cause this test to fail?
|
|
||||||
9. What legitimate changes should not cause this test to fail?
|
|
||||||
10. What ongoing maintenance, execution, and diagnostic cost will the test impose?
|
|
||||||
11. Is there a smaller or more direct test that protects the same risk?
|
|
||||||
|
|
||||||
Do not add the test when its expected lifetime cost exceeds its expected protective value.
|
|
||||||
|
|
||||||
When deciding not to test plausible behavior, record or be able to explain why the risk is low, already protected, obvious, reversible, or cheaper to detect elsewhere.
|
|
||||||
|
|
||||||
## Definition of sufficient
|
## Definition of sufficient
|
||||||
|
|
||||||
A test suite is sufficient when:
|
A test suite is sufficient when:
|
||||||
|
|
||||||
- important contracts and invariants are protected;
|
- important requested behavior and established contracts are protected against realistic, consequential failures;
|
||||||
- meaningful boundaries and failure modes are exercised;
|
- boundaries and component interactions have coverage where they introduce meaningful risks not protected elsewhere;
|
||||||
- realistic and consequential regressions are credibly protected against silent recurrence;
|
- failures provide useful, distinct signals;
|
||||||
- behavior involving data integrity, destructive operations, compatibility, security, concurrency, idempotency, and recovery is credibly protected;
|
- tests usually remain stable through legitimate internal changes; and
|
||||||
- important external boundaries have realistic integration coverage;
|
|
||||||
- representative complete workflows are tested;
|
|
||||||
- failures provide useful signal rather than redundant noise;
|
|
||||||
- legitimate internal changes usually do not require test edits; and
|
|
||||||
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
||||||
|
|
||||||
Sufficiency is a risk judgment, not a coverage percentage or test count. Reassess it as the application, its users, and the consequences of failure evolve.
|
Reassess sufficiency as the application, its users, and the consequences of
|
||||||
|
failure evolve.
|
||||||
The governing rule is:
|
|
||||||
|
|
||||||
> Test heavily where failure is consequential, subtle, or difficult to detect after the fact. Test lightly where failure is obvious, reversible, and inexpensive—and retain no test whose lifetime cost exceeds the confidence it provides.
|
|
||||||
|
|||||||
240
docs/release.md
240
docs/release.md
@@ -1,167 +1,137 @@
|
|||||||
# Releasing Narratio
|
# Releasing Narratio
|
||||||
|
|
||||||
This is the maintainer runbook for the [Release Policy](policy/release.md).
|
This is the maintainer runbook for the [Release Policy](policy/release.md).
|
||||||
Its [explicit exceptions](policy/release.md#policy-exceptions) preserve the
|
The source release completes when the intended tag is successfully pushed to
|
||||||
successful tag push as the automated responsibility boundary. Binary publication
|
`origin`; binary delivery is a separate asynchronous status.
|
||||||
is asynchronous; later consumer-facing inspection is optional.
|
|
||||||
|
|
||||||
## Prerequisites and publication scope
|
## Prepare the candidate
|
||||||
|
|
||||||
Use a checkout on `main` with Git authentication permitting fetches and pushes
|
Use `main` and the authoritative Git remote `origin`. Install Git, a POSIX
|
||||||
to `origin`, the authoritative Git remote. Install Git, a POSIX shell, standard
|
shell, standard Unix build tools, and the [release toolchain](#release-toolchain).
|
||||||
Unix build tools, and the Go toolchain below. Make required modules available
|
Have the selected Go modules available before offline validation. Git access
|
||||||
before offline validation. No model/provider credentials are needed. Gitea
|
must permit fetch and tag push.
|
||||||
publication credentials belong to CI's secret store, not the local command.
|
Application-provider credentials are not required; Gitea delivery credentials
|
||||||
|
belong to CI.
|
||||||
|
|
||||||
Synchronous guards inspect local tags and `origin`, not every configured remote
|
Choose an unused stable `vMAJOR.MINOR.PATCH` under the
|
||||||
or Gitea release entry. Do not select a version known to have been published in
|
[compatibility rules](policy/release.md#versioning-and-compatibility). Narratio
|
||||||
any channel, even if these guards cannot see it.
|
is past v1.0.0; apply the policy's effective-configuration compatibility
|
||||||
|
definition and Go consumer-minimum exception. Update affected canonical
|
||||||
|
documentation with the change. Write the matching
|
||||||
|
`docs/releases/vMAJOR.MINOR.PATCH.md` with a short summary and any
|
||||||
|
relevant compatibility impact or upgrade action; choose sections to suit the
|
||||||
|
release.
|
||||||
|
|
||||||
## Go prerequisite
|
End that checked-in note with these three links, replacing the version in
|
||||||
|
each URL with the intended tag. The tag need not exist remotely yet. Check that
|
||||||
|
`COPYRIGHT`, `LICENSE`, and `docs/oss/attribution.md` are present in the
|
||||||
|
candidate. The tag CI reuses the checked-in note as the hosted release body.
|
||||||
|
|
||||||
Release preparation requires the maintained Go 1.26 baseline. Tag CI currently
|
```markdown
|
||||||
uses the explicitly pinned `golang:1.26.7` image for validation and asset builds.
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/narratio/src/tag/vMAJOR.MINOR.PATCH/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/narratio/src/tag/vMAJOR.MINOR.PATCH/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/narratio/src/tag/vMAJOR.MINOR.PATCH/docs/oss/attribution.md)
|
||||||
That asynchronous work does not change the tag-push completion boundary.
|
```
|
||||||
|
|
||||||
## Choose a version and write its note
|
Retire completed roadmaps included in the release while preserving planned or
|
||||||
|
deferred work and repairing affected links. Review the change through the
|
||||||
Select an unused stable version under the
|
ordinary development workflow for unintended files, credentials, private data,
|
||||||
[versioning rules](policy/release.md#versioning-and-compatibility). Narratio is
|
and documentation accuracy. Commit and push the candidate to `origin/main`
|
||||||
past v1.0.0; intentional CLI/configuration breaks require a major release.
|
before tagging; record its exact commit if needed:
|
||||||
|
|
||||||
Create `docs/releases/vMAJOR.MINOR.PATCH.md` using the
|
|
||||||
[required note structure](policy/release.md#release-documentation).
|
|
||||||
Describe CLI, configuration, artifact, integration, and operating-contract
|
|
||||||
changes, and the required operator action. Link to current canonical
|
|
||||||
documentation for exact behavior.
|
|
||||||
|
|
||||||
## Prepare and record the candidate
|
|
||||||
|
|
||||||
Before committing, perform these manual reviews in addition to automated checks:
|
|
||||||
|
|
||||||
- Confirm compatibility/version selection and update affected canonical
|
|
||||||
documentation and maintained examples.
|
|
||||||
- Remove completed roadmap documents covering work included in this release;
|
|
||||||
retain pending work. Their history remains in Git. Do not delete historical
|
|
||||||
release notes.
|
|
||||||
- Review the diff, staged changes, and untracked files for credentials, private
|
|
||||||
data, generated output, unintended files, and unrelated changes.
|
|
||||||
- Review changed documentation links and behavior-bearing commands. Automated
|
|
||||||
link checks supplement rather than replace review.
|
|
||||||
|
|
||||||
Commit the note and candidate changes, then push that commit to `main` through
|
|
||||||
the ordinary development workflow. Record the exact candidate:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git rev-parse HEAD
|
git rev-parse HEAD
|
||||||
```
|
```
|
||||||
|
|
||||||
Do not create a tag until `origin/main` points to that same commit. If the
|
## Release toolchain
|
||||||
candidate changes, repeat the reviews and validation.
|
|
||||||
|
|
||||||
## Validate the candidate
|
The selected release toolchain is Go 1.27.4, matching the validation and build
|
||||||
|
jobs in `.woodpecker/release.yml`. With an official Go installation available,
|
||||||
From the repository root, run:
|
select it before candidate validation and publication:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
scripts/check-release-candidate.sh vMAJOR.MINOR.PATCH
|
export GOTOOLCHAIN=go1.27.4
|
||||||
|
go version
|
||||||
```
|
```
|
||||||
|
|
||||||
The script also works when invoked by its absolute path from another directory.
|
Go downloads the selected toolchain if needed. Complete that setup and module
|
||||||
It validates the version and matching note, module hygiene, formatting,
|
preparation before offline candidate validation. Keep this selection and the
|
||||||
whitespace, uncached tests, race tests, static checks, documentation, examples,
|
release CI images aligned when deliberately updating the release toolchain.
|
||||||
and three cross-build assets. It uses `GOWORK=off`, does not contact application
|
|
||||||
services, CI, or Gitea, and does not create tags or modify tracked source.
|
|
||||||
Fix failures on `main`, commit, push normally, and rerun validation.
|
|
||||||
|
|
||||||
The macOS cross-build proves compilation, not native runtime behavior.
|
The consumer minimum is Go 1.27.0 as declared in `go.mod`.
|
||||||
|
Successful release validation on the selected patch establishes presumed
|
||||||
|
support across that series, subject to the declared minimum and concrete
|
||||||
|
evidence of incompatibility, under the
|
||||||
|
[release policy](policy/release.md#consumer-minimum-and-release-toolchain).
|
||||||
|
|
||||||
## Declared deliverables and automation
|
## Publish
|
||||||
|
|
||||||
The source release is the exact version tag at the validated commit.
|
From a clean `main` checkout at the pushed candidate, run one command:
|
||||||
The tag-triggered `.woodpecker/release.yml` validates the tagged source,
|
|
||||||
runs `scripts/build-release-assets.sh`, and publishes these Gitea assets:
|
```sh
|
||||||
|
scripts/release.sh vMAJOR.MINOR.PATCH
|
||||||
|
```
|
||||||
|
|
||||||
|
It fetches `origin/main` and tags; requires local `HEAD` to equal
|
||||||
|
`origin/main`; checks the committed note and unused version; runs the
|
||||||
|
candidate checker **once**; then repeats cheap mutable-state guards before
|
||||||
|
creating an unsigned lightweight tag at the recorded commit. It verifies the
|
||||||
|
tag target and pushes only
|
||||||
|
`refs/tags/vMAJOR.MINOR.PATCH:refs/tags/vMAJOR.MINOR.PATCH`. It does not
|
||||||
|
commit, push `main`, force updates, or publish all tags.
|
||||||
|
|
||||||
|
The checker runs `go mod tidy -diff`, tracked Go formatting and diff whitespace
|
||||||
|
checks, one `go test -mod=readonly -race -count=1 ./...` full suite, and
|
||||||
|
`go vet -mod=readonly ./...`. Its asset builder cross-builds Linux amd64,
|
||||||
|
Linux arm64, and best-effort macOS arm64, then checks the embedded version
|
||||||
|
on a host binary. The macOS cross-build proves compilation, not native
|
||||||
|
runtime behavior. Owned Go commands run with `GOWORK=off`; tests, vet, and
|
||||||
|
builds use readonly module mode. The deterministic suite includes documentation
|
||||||
|
and maintained-example checks. The command does not contact application
|
||||||
|
services or Gitea and does not wait for CI.
|
||||||
|
|
||||||
|
A successful tag push is the source-release completion point. The command
|
||||||
|
prints the tag and commit and exits without a separate network read-back.
|
||||||
|
For optional diagnosis before publication, run
|
||||||
|
`scripts/check-release-candidate.sh vMAJOR.MINOR.PATCH`; publication will
|
||||||
|
validate the candidate again, so this is not a required preparation step.
|
||||||
|
|
||||||
|
## Artifact delivery
|
||||||
|
|
||||||
|
Tag-triggered `.woodpecker/release.yml` independently validates the tagged
|
||||||
|
source, builds the same three targets, and publishes these Gitea downloads:
|
||||||
|
|
||||||
- `narratio-vMAJOR.MINOR.PATCH-linux-amd64`
|
- `narratio-vMAJOR.MINOR.PATCH-linux-amd64`
|
||||||
- `narratio-vMAJOR.MINOR.PATCH-linux-arm64`
|
- `narratio-vMAJOR.MINOR.PATCH-linux-arm64`
|
||||||
- `narratio-vMAJOR.MINOR.PATCH-darwin-arm64` (best effort)
|
- `narratio-vMAJOR.MINOR.PATCH-darwin-arm64` (best effort)
|
||||||
- `SHA256SUMS`
|
- `SHA256SUMS`
|
||||||
|
|
||||||
The builder embeds the version, disables ambient Go workspaces, and checks a
|
The builder embeds the tag version and checks host `version` output. CI
|
||||||
host binary's `version` output. The release publisher uses the matching
|
generates checksums and uses non-overwriting publication settings. It does
|
||||||
checked-in note and generates SHA-256 checksums. Existing files are skipped and
|
not select versions, change the source, or move tags. No image or package
|
||||||
overwrite is disabled. No image or package-registry deliverable is declared.
|
registry output is declared. Tag publication is not proof that these
|
||||||
CI does not choose versions, modify source candidates, or move tags.
|
asynchronous downloads are available.
|
||||||
|
|
||||||
## Publish the tag
|
## Failure and recovery
|
||||||
|
|
||||||
From a clean checkout on `main` whose `HEAD` equals `origin/main`, run:
|
If validation fails before tagging, correct and commit the candidate, push
|
||||||
|
it to `main`, and rerun the publication command. If the tag push reports
|
||||||
|
failure, its outcome may be ambiguous: keep the local tag and inspect the
|
||||||
|
exact `refs/tags/vMAJOR.MINOR.PATCH` at `origin` before declaring success
|
||||||
|
or retrying. A reachable matching remote tag at the recorded commit establishes
|
||||||
|
publication; a confirmed absent tag permits investigation of the transport
|
||||||
|
failure. If `origin` cannot be inspected, publication status is unknown.
|
||||||
|
Do not move, overwrite, or automatically retry the tag. Remove a local tag
|
||||||
|
only after confirming it was never published or used by a release channel.
|
||||||
|
|
||||||
```sh
|
A transient CI or delivery failure can be retried from the same immutable
|
||||||
scripts/release.sh vMAJOR.MINOR.PATCH
|
tag. Missing assets may be added later if they match the tagged source and
|
||||||
```
|
any published checksum manifest; do not overwrite existing binaries,
|
||||||
|
checksums, or release-note contents. A source/content defect, or delivery
|
||||||
|
that cannot be corrected without replacement, requires a new suitable
|
||||||
|
version and matching note. Leave the original release intact.
|
||||||
|
|
||||||
The command fetches and checks `origin/main`, re-runs candidate validation,
|
Optional consumer inspection may compare the tag's remote commit with the
|
||||||
then fetches and checks again before creating an explicitly unsigned lightweight
|
recorded candidate, check the Woodpecker delivery job and hosted Gitea note,
|
||||||
tag for the originally recorded commit. It refuses dirty, divergent, changed,
|
download the assets into an empty directory, run `sha256sum --check
|
||||||
or already-tagged candidates. It verifies the local tag target and pushes only:
|
SHA256SUMS` (or `shasum -a 256 --check SHA256SUMS` on macOS), and run
|
||||||
|
the matching host binary's `version` command. This is separate delivery
|
||||||
```text
|
observation, never a source-release gate.
|
||||||
refs/tags/vMAJOR.MINOR.PATCH:refs/tags/vMAJOR.MINOR.PATCH
|
|
||||||
```
|
|
||||||
|
|
||||||
It never commits changes, pushes `main`, force-pushes, moves tags, or pushes all
|
|
||||||
tags. Successful publication of that ref completes the command; it prints the
|
|
||||||
tag and commit and returns without waiting for CI, querying Gitea, downloading
|
|
||||||
assets, or checking checksums.
|
|
||||||
|
|
||||||
## Failure handling
|
|
||||||
|
|
||||||
Before tag creation, correct the candidate on `main` and repeat validation.
|
|
||||||
If a push fails after local tag creation, the local tag is retained for inspection.
|
|
||||||
Do not retry blindly or assume the remote received nothing: a connection failure
|
|
||||||
can leave publication uncertain. Inspect the exact remote ref before taking any
|
|
||||||
local-tag cleanup action. This is recovery from a failed command, not a
|
|
||||||
post-success publication gate.
|
|
||||||
|
|
||||||
After publication, follow the
|
|
||||||
[immutability and correction rules](policy/release.md#immutability-and-correction).
|
|
||||||
Correct defects or failed asynchronous publication with a new semantically
|
|
||||||
appropriate version, matching note, and the complete procedure. Never replace
|
|
||||||
existing tagged assets in place.
|
|
||||||
|
|
||||||
## Optional asynchronous inspection
|
|
||||||
|
|
||||||
A human may later inspect the tag-triggered Woodpecker job and Gitea release.
|
|
||||||
This is optional follow-up, never part of the automated releaser's completion
|
|
||||||
criteria. Do not wait for or poll CI/Gitea from the release command.
|
|
||||||
|
|
||||||
For optional source verification, substitute the released version below and
|
|
||||||
compare the remote target to the recorded candidate hash:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git ls-remote --tags origin refs/tags/vMAJOR.MINOR.PATCH
|
|
||||||
git rev-parse 'refs/tags/vMAJOR.MINOR.PATCH^{commit}'
|
|
||||||
```
|
|
||||||
|
|
||||||
Download the three named binaries and `SHA256SUMS` from the matching Gitea release
|
|
||||||
into an empty inspection directory. In that directory, verify on Linux:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sha256sum --check SHA256SUMS
|
|
||||||
```
|
|
||||||
|
|
||||||
On macOS, use `shasum -a 256 --check SHA256SUMS`. After successful verification,
|
|
||||||
make the matching host binary executable and run its version command, for example
|
|
||||||
on Linux amd64 (replace the version in both commands):
|
|
||||||
|
|
||||||
```sh
|
|
||||||
chmod +x ./narratio-vMAJOR.MINOR.PATCH-linux-amd64
|
|
||||||
./narratio-vMAJOR.MINOR.PATCH-linux-amd64 version
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected output is `narratio vMAJOR.MINOR.PATCH`. Use only the matching architecture
|
|
||||||
on other supported hosts. Checksums establish consistency with the downloaded
|
|
||||||
checksum file, not a new signature or independent authenticity guarantee.
|
|
||||||
Missing assets are an asynchronous publication problem, not grounds to move or
|
|
||||||
reuse the successfully published source tag.
|
|
||||||
|
|||||||
@@ -1,27 +1,23 @@
|
|||||||
# Release Notes
|
# Release Notes
|
||||||
|
|
||||||
This directory contains immutable historical release notes for Narratio.
|
This directory contains immutable historical release notes for Narratio.
|
||||||
Future notes are created with the matching stable version and use this minimum
|
Future notes use the matching stable version and begin with
|
||||||
structure:
|
`# Narratio vMAJOR.MINOR.PATCH`. Include a short summary and relevant
|
||||||
|
compatibility or upgrade guidance; choose sections suited to the release.
|
||||||
```markdown
|
End each new note with the three immutable-tag notice links specified in the
|
||||||
# Narratio vMAJOR.MINOR.PATCH
|
[release procedure](../release.md).
|
||||||
|
|
||||||
This release ...
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
## Compatibility
|
|
||||||
|
|
||||||
## Upgrade
|
|
||||||
|
|
||||||
## Changes
|
|
||||||
```
|
|
||||||
|
|
||||||
See the [release procedure](../release.md) for creating a candidate and tag.
|
See the [release procedure](../release.md) for creating a candidate and tag.
|
||||||
When asynchronous publication succeeds, the corresponding Gitea release is the
|
When asynchronous publication succeeds, the corresponding Gitea release is the
|
||||||
canonical source for downloadable binaries and checksums.
|
canonical source for downloadable binaries and checksums.
|
||||||
|
|
||||||
|
- [v3.1.0](v3.1.0.md)
|
||||||
|
- [v3.0.0](v3.0.0.md)
|
||||||
|
- [v2.2.1](v2.2.1.md)
|
||||||
|
- [v2.2.0](v2.2.0.md)
|
||||||
|
- [v2.1.2](v2.1.2.md)
|
||||||
|
- [v2.1.1](v2.1.1.md)
|
||||||
|
- [v2.1.0](v2.1.0.md)
|
||||||
- [v2.0.0](v2.0.0.md)
|
- [v2.0.0](v2.0.0.md)
|
||||||
- [v1.7.0](v1.7.0.md)
|
- [v1.7.0](v1.7.0.md)
|
||||||
- [v1.6.0](v1.6.0.md)
|
- [v1.6.0](v1.6.0.md)
|
||||||
|
|||||||
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)
|
||||||
40
docs/releases/v3.1.0.md
Normal file
40
docs/releases/v3.1.0.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# Narratio v3.1.0
|
||||||
|
|
||||||
|
This minor release adds explicit provider-credential forwarding to Scriptorium
|
||||||
|
for trim bounds generation and artifact analysis.
|
||||||
|
|
||||||
|
## Compatibility and upgrade
|
||||||
|
|
||||||
|
Existing pipelines remain valid. An omitted, null, or empty
|
||||||
|
`pipeline.scriptorium.credentials` list continues to forward no provider keys.
|
||||||
|
When Scriptorium needs a credential, provision its environment variable through
|
||||||
|
Narratio's existing environment or secrets-directory mechanism and list the
|
||||||
|
exact name in the pipeline, for example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
scriptorium:
|
||||||
|
credentials: [OPENROUTER_API_KEY]
|
||||||
|
```
|
||||||
|
|
||||||
|
Selected references must resolve to nonempty values when Narratio loads the
|
||||||
|
pipeline, even if the current command will not run Scriptorium. A Narratio
|
||||||
|
overlay replaces the complete list, and `[]` clears it. After correcting a
|
||||||
|
failed trim or analysis invocation, retry normally; successful work need not be
|
||||||
|
forced solely because a credential was added or rotated. See
|
||||||
|
[Scriptorium credentials](../config.md#scriptorium-credentials) and the
|
||||||
|
[401 troubleshooting guide](../troubleshooting.md#scriptorium-returns-http-401-during-trim-or-analyze).
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Forward selected, already-resolved credential names and values to Scriptorium
|
||||||
|
for trim, analysis, character-family generation, and render-debug calls.
|
||||||
|
Scriptorium still owns provider and profile selection; Narratio does not add
|
||||||
|
a model-request `--api-key-env` override.
|
||||||
|
- Register selected values for captured subprocess-output and failure-diagnostic
|
||||||
|
redaction. Inspection and invocation metadata contain credential names, never
|
||||||
|
their values. This protection does not scan files Scriptorium writes directly.
|
||||||
|
- Reuse the credential-forwarding boundary shared with Audita and Notarius.
|
||||||
|
Retire the completed Scriptorium credential-forwarding bug report from the
|
||||||
|
source roadmap; its history remains in Git.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/narratio/src/tag/v3.1.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/narratio/src/tag/v3.1.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/narratio/src/tag/v3.1.0/docs/oss/attribution.md)
|
||||||
@@ -1,288 +1,175 @@
|
|||||||
# Adopt Audita v2 and ConfigKit v0.4.0
|
# Adopt Audita v3 and independent diagnostic destinations
|
||||||
|
|
||||||
Status: implemented (2026-09-25); release pending.
|
## Purpose
|
||||||
|
|
||||||
## Goal
|
Adopt Audita v3.0.0 for transcript polishing and use its independent output
|
||||||
|
destinations to implement the Audita portion of the
|
||||||
|
[session workspace roadmap](workspace.md). Operators should find the completed
|
||||||
|
transcript, ordinary reports, and optional debug evidence in their respective
|
||||||
|
Narratio locations.
|
||||||
|
|
||||||
Migrate Narratio's `polish` integration from Audita's former command/configuration
|
This document defines the Audita adoption scope and target. The workspace
|
||||||
contract to Audita v2.0.0. Keep Narratio responsible for orchestration and Audita
|
roadmap owns shared layout, latest-attempt views, and retention behavior. Its
|
||||||
responsible for correction behavior and LLM execution configuration.
|
referenced ADRs remain Proposed. Implementation sequencing belongs in a
|
||||||
|
subsequent implementation plan.
|
||||||
|
|
||||||
Adopt a consistent provider-named credential list for both Audita and Notarius,
|
## Reviewed Upstream Release
|
||||||
so operators define each secret once and explicitly share it with the downstream
|
|
||||||
applications that need it. This is a clean cutover without backward-compatibility
|
|
||||||
shims.
|
|
||||||
|
|
||||||
Adopt ConfigKit v0.4.0 and use “overlay” consistently for Narratio's selected
|
The reviewed Audita v3.0.0 tag identifies commit
|
||||||
pipeline configuration, distinct from downstream LLM model profiles.
|
`3b4933256eff84327b812e7ae12babf743bc04a6`. Its
|
||||||
|
[release notes](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/docs/releases/v3.0.0.md),
|
||||||
|
[CLI reference](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/docs/cli.md),
|
||||||
|
[configuration reference](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/docs/config.md),
|
||||||
|
and [operations guide](https://gitea.maximumdirect.net/eric/audita/src/tag/v3.0.0/docs/operations.md)
|
||||||
|
own the downstream contracts.
|
||||||
|
|
||||||
Production runs use Audita's default reporting configuration: Narratio passes
|
Audita now honors an explicit `--report-dir` alongside file transcript output.
|
||||||
neither `--debug` nor `--reporting=false`. Normal reports remain available without
|
Its existing `--work-dir` selects the parent of retained debug captures, with
|
||||||
enabling debug diagnostics. Adding debug reporting through Narratio's testing
|
capture enabled separately through configuration or `--debug`. These controls
|
||||||
profile is deferred.
|
satisfy Narratio's requested destination separation. Further upstream changes
|
||||||
|
are unnecessary for this scope.
|
||||||
|
|
||||||
This document defines the intended end state, migration scope, and policy.
|
## Current Baseline
|
||||||
The [implementation plan](implementation.md) owns implementation sequencing and
|
|
||||||
verification steps.
|
|
||||||
|
|
||||||
## Baseline and upstream contract
|
Narratio's [Audita integration](../integrations/audita.md) and
|
||||||
|
[polish stage](../internal/stage-polish.md) describe the implemented behavior:
|
||||||
|
|
||||||
The baseline is Narratio v2.2.1 and the Audita checkout tagged v2.0.0. Upstream
|
- The adapter invokes `process` with a transcript, glossary, and staged transcript
|
||||||
references are Audita's `docs/migrations/v2.md`, `docs/cli.md`,
|
destination. It supports independent downstream configuration, overlay,
|
||||||
`docs/integrations/subprocess.md`, and `docs/integrations/output-files.md`,
|
profile, module, description, and output-schema selectors.
|
||||||
available in the sibling `../audita/` checkout. Narratio's current contract is
|
- The adapter supplies no reporting, debug, or work-directory flags. Audita
|
||||||
documented in [Integration: Audita](../integrations/audita.md).
|
controls debug capture and placement through its own configuration.
|
||||||
|
- Ordinary reports are discovered beside the staged transcript. The polish
|
||||||
|
stage validates returned report paths against those adjacent filenames.
|
||||||
|
- Only the validated polished transcript becomes a canonical stage output.
|
||||||
|
Reports, captured streams, and the generated invocation record are diagnostics.
|
||||||
|
- Selected credential references use Narratio's shared exact-name forwarding and
|
||||||
|
captured-stream redaction boundary.
|
||||||
|
|
||||||
The current integration is not compatible with Audita v2:
|
The existing invocation remains usable with Audita v3 after deployment-side
|
||||||
|
profile migration. Narratio changes are needed to request and consume the
|
||||||
|
new destination separation.
|
||||||
|
|
||||||
- It requests `--report-json` by default; that flag has been removed.
|
## Targeted End State
|
||||||
- It can pass retired endpoint, model, concurrency, and work-directory-retention
|
|
||||||
flags.
|
|
||||||
- It expects one JSON report instead of the normal v2 report bundle.
|
|
||||||
- Its single forwarded `AUDITA_LLM_API_KEY` has no implicit meaning in v2;
|
|
||||||
an Audita backend must explicitly reference that environment variable.
|
|
||||||
- Its semantic fingerprint sorts modules, although Audita treats module order
|
|
||||||
and repetitions as meaningful.
|
|
||||||
|
|
||||||
Audita v2 requires a version-2 configuration file. An explicit `--config` selects
|
### Products and diagnostics
|
||||||
one; otherwise Audita performs its own documented discovery. Backend definitions
|
|
||||||
own endpoints, credentials, and capacity. PromptKit profiles own models and
|
|
||||||
per-attempt controls. Audita owns retry/repair policy and operation deadlines.
|
|
||||||
Narratio's generated invocation YAML is a diagnostic record, not a substitute
|
|
||||||
for that Audita configuration file.
|
|
||||||
|
|
||||||
## Target architecture
|
Narratio supplies separate destinations for each actual polish attempt:
|
||||||
|
|
||||||
Retain the existing subprocess boundary and `polish` stage. Do not introduce a
|
| Content | Destination and control |
|
||||||
second correction engine, an in-process Audita dependency, or a generic external
|
| --- | --- |
|
||||||
tool configuration framework.
|
| Corrected transcript | Run-local staging via `--output`; validated and promoted to `transcripts/polished.json` on success. |
|
||||||
|
| Ordinary reports | `runs/<run_id>/polish/logs/` via `--report-dir`. |
|
||||||
|
| Captured stdout, stderr, and Narratio invocation record | The same run-local polish log directory. |
|
||||||
|
| Optional debug evidence | `runs/<run_id>/polish/debug/` via `--work-dir`; Audita may create its own `run-*` subdirectory beneath it. |
|
||||||
|
|
||||||
Narratio owns:
|
The workspace roadmap's `logs/polish` and `debug/polish` links expose the latest
|
||||||
|
attempt. Narratio supplies actual run destinations to Audita and records those
|
||||||
|
paths in manifest diagnostics. Shared link updates and cleanup protection are
|
||||||
|
implemented by the workspace work rather than separately inside the adapter.
|
||||||
|
|
||||||
- Selection of the executable and the overall invocation timeout/cancellation.
|
### Capture selection
|
||||||
- Transcript and glossary inputs, run-local output placement, validation of the
|
|
||||||
corrected transcript, and promotion to the existing polished transcript
|
|
||||||
identity.
|
|
||||||
- Explicit configuration/profile selections and supported domain overrides.
|
|
||||||
- Deliberate credential forwarding, secret-safe invocation diagnostics, and
|
|
||||||
manifest references to results and reports.
|
|
||||||
- Existing stage completion, resume, force, publish, restore, and cleanup
|
|
||||||
behavior.
|
|
||||||
|
|
||||||
Audita owns its configuration schema and discovery, backend/model configuration,
|
Add an optional `pipeline.audita.debug` boolean, defaulting to false. A true
|
||||||
provider execution, correction sequence, recovery behavior, and report contents.
|
value passes `--debug`. False or omission supplies no capture override and
|
||||||
Narratio does not translate old settings into a generated v2 configuration or
|
preserves Audita configuration and overlay behavior; it does not disable debug
|
||||||
duplicate Audita's complete validation logic.
|
enabled downstream.
|
||||||
|
|
||||||
## Configuration and invocation migration
|
Supply `--work-dir` for each executing attempt so downstream-enabled capture
|
||||||
|
also lands in the Narratio-selected debug directory. Selecting that destination
|
||||||
|
alone does not enable capture. Ordinary production operation retains Audita's
|
||||||
|
default reporting and debug settings. Narratio adds no reporting enable/disable
|
||||||
|
flag or debug-disable flag.
|
||||||
|
|
||||||
### ConfigKit and pipeline overlays
|
Debug selection affects diagnostics for an executing stage. Changing it alone
|
||||||
|
does not invalidate a completed transcript. Operators use the existing force
|
||||||
|
workflow when fresh polish or debug evidence is needed.
|
||||||
|
|
||||||
Upgrade Narratio's ConfigKit dependency from v0.3.1 to v0.4.0. ConfigKit's
|
### Ownership and compatibility
|
||||||
selected-configuration terminology changes from profile to overlay: the Go API
|
|
||||||
uses `Options.Overlay`, `LayerOverlay`, and `CodeOverlay*`; source layers and
|
|
||||||
diagnostic codes use `overlay` and `overlay.*`. Composition, precedence, secret
|
|
||||||
resolution, and lifecycle semantics otherwise remain unchanged.
|
|
||||||
|
|
||||||
Narratio's pipeline-selection interface becomes `--overlay`, selecting
|
Use a clean adoption of Audita v3's CLI contract, without version-dependent
|
||||||
`overlays/<name>.yml` beside the root pipeline file. Remove `--profile` and old
|
adapter branches or legacy profile conversion. Audita continues to own its
|
||||||
selected-directory discovery without aliases or fallbacks. Preserve existing
|
configuration, profiles, prompts, runtime State, and diagnostic contents.
|
||||||
base selection for omission, explicit empty selection, and `default`.
|
Narratio owns supplied destinations and transcript promotion.
|
||||||
Configuration inspection, diff descriptions, internal selection names, and
|
|
||||||
newly written selection provenance use overlay terminology as well.
|
|
||||||
|
|
||||||
Maintain existing value-based digest and stage-reuse semantics; renaming
|
Keep existing selectors and shared credentials such as `OPENROUTER_API_KEY` and
|
||||||
informational selection provenance is not a reason to invalidate completed
|
`RAKESTRAWHOME_API_KEY` under their configured exact names. Audita's examples
|
||||||
work or automatically rewrite historical manifests. Strict manifest decoding
|
do not require Narratio to adopt application-specific credential aliases.
|
||||||
rejects retired provenance fields; operators must deliberately migrate that
|
Operators continue to list the credential references required by all configured
|
||||||
informational member on a backed-up manifest, preserving execution/checkpoint
|
Audita backends.
|
||||||
state. Update maintained examples and operator migration guidance for the
|
|
||||||
directory, flag, and provenance changes.
|
|
||||||
|
|
||||||
This rename does not apply to downstream model profiles, Scriptorium
|
Audita is a separately installed executable. Its adoption of ConfigKit v0.5.0
|
||||||
`profile_id`, Audita's proposal/validation profiles, or Notarius's
|
and PromptKit v0.12.0 does not require changing Narratio's own library
|
||||||
`config_profile`. Nor does it prohibit ordinary explicit imports from a directory
|
dependencies as part of this feature.
|
||||||
named `profiles`. Narratio overlays do not automatically select downstream
|
|
||||||
overlays or profiles. These are independently owned choices.
|
|
||||||
|
|
||||||
### Audita v2 configuration
|
## Required Changes
|
||||||
|
|
||||||
Keep binary, timeout, explicit config-path selection, and surviving explicit
|
### Deployment configuration migration
|
||||||
domain overrides such as transcript description, output schema, and modules.
|
|
||||||
Allow Audita's native configuration discovery when no config path is selected;
|
|
||||||
do not impose an additional requirement to supply an explicit path.
|
|
||||||
|
|
||||||
Provide optional Audita overlay, proposal-profile, and validation-profile
|
Document the manual migration of Audita-owned PromptKit files:
|
||||||
selectors, passed through to their corresponding CLI flags. Omission leaves
|
|
||||||
Audita's own defaults and validation-profile inheritance in control. These are
|
|
||||||
Audita selectors, not automatic translations of Narratio overlay names.
|
|
||||||
|
|
||||||
Retire the Narratio settings that mirror removed Audita endpoint/model/capacity
|
- Wrap profile definitions under keyed `profiles:` mappings, remove inner `id`
|
||||||
flags and work-directory retention. Move their operational meaning into the
|
fields, and replace `base_profile` with `extends`. Preserve selected profile
|
||||||
operator-maintained Audita configuration and profiles. Remove stale adapter
|
IDs when appropriate.
|
||||||
fields, validation, invocation metadata, examples, and tests along with them.
|
- Review explicit zeros, omitted values, and nulls against the new generation
|
||||||
Remove the old report toggle and both adapters' singular `llm_api_key` fields
|
control semantics. Validate the final configuration root, including unused
|
||||||
from accepted Narratio configuration. Do not retain deprecated aliases,
|
definitions and backend references.
|
||||||
automatic conversion, ignored fields, or a v1 execution path. Existing strict
|
- Rename any backend literally named `extends` and update its references.
|
||||||
configuration decoding rejects removed fields. Provide migration guidance and a
|
- Validate production configuration and each used testing overlay with Audita's
|
||||||
release compatibility notice rather than runtime compatibility machinery.
|
offline `config validate` command. Audita application configuration continues
|
||||||
|
to use `version: 2`.
|
||||||
|
|
||||||
Preserve the distinction between omitted modules and an explicitly empty module
|
Keep the detailed downstream format owned by the pinned Audita documentation.
|
||||||
list: omission requests Audita's configured/default sequence; an empty list
|
Narratio does not inspect, rewrite, or automatically migrate these files.
|
||||||
requests no correction modules. Preserve order and repetitions rather than
|
Deployment can migrate Audita before the workspace changes land.
|
||||||
sorting or deduplicating. Do not broaden this into a change to unrelated
|
|
||||||
adapters' module semantics.
|
|
||||||
|
|
||||||
Normal invocations no longer pass `--report-json`, `--work-dir-retention`, or
|
### Adapter and polish stage
|
||||||
debug-work-directory flags as a way to obtain reports. They need no reporting
|
|
||||||
override: Audita writes its ordinary report bundle by default. The old
|
|
||||||
Narratio `report` toggle must not silently become `--reporting=false`.
|
|
||||||
|
|
||||||
The production Audita configuration must also retain reporting enabled and debug
|
Carry explicit report and debug destinations through the Audita request and
|
||||||
disabled. Omitting CLI flags does not override an operator's explicit external
|
construct the supported flags inside the adapter. Wire the debug selector
|
||||||
configuration. Document this distinction rather than silently adding forced
|
through configuration and runner composition.
|
||||||
boolean overrides or rejecting otherwise valid Audita configuration.
|
|
||||||
|
|
||||||
## Credentials
|
Discover the existing three report filenames in the requested report directory.
|
||||||
|
Update polish's expected-path validation to the same location. Update invocation
|
||||||
|
records and safe result metadata to describe the selected destinations and
|
||||||
|
capture request. Preserve available failure evidence and the original subprocess
|
||||||
|
error.
|
||||||
|
|
||||||
Define secrets once under provider-oriented environment-variable names, such as
|
Keep existing transcript validation, report read bounds, timeouts, credential
|
||||||
`OPENROUTER_API_KEY` and `RAKESTRAWHOME_API_KEY`, through the process environment
|
forwarding, and captured-stream redaction. Reports remain optional diagnostics;
|
||||||
or Narratio's existing secrets-directory bootstrap. These names are examples,
|
early failures or downstream-disabled reporting may produce none. Exit-zero
|
||||||
not a fixed provider registry; application-specific names are not required.
|
runs with recoverable model errors remain successful. A nonzero exit, including
|
||||||
|
a late report-write failure, never authorizes transcript promotion. Narratio
|
||||||
|
does not add report-schema parsing or report-status success gates.
|
||||||
|
|
||||||
Add `pipeline.audita.credentials` and `pipeline.notarius.credentials` as lists
|
### Workspace integration and lifecycle
|
||||||
of Narratio typed secret references. Each entry names the environment variable
|
|
||||||
whose captured value is forwarded under that exact name. Omission or an empty
|
|
||||||
list forwards no credentials. The same reference may appear in both adapters'
|
|
||||||
lists without duplicating its stored secret value. An illustrative configuration
|
|
||||||
fragment is:
|
|
||||||
|
|
||||||
```yaml
|
Use the shared workspace path owner for run-local log/debug destinations and
|
||||||
pipeline:
|
the agreed latest-attempt behavior. Preserve previous views on skipped stages;
|
||||||
audita:
|
actual attempts refresh both views, including on failure. An attempt without
|
||||||
credentials:
|
debug capture exposes an empty current debug directory.
|
||||||
- OPENROUTER_API_KEY
|
|
||||||
- RAKESTRAWHOME_API_KEY
|
|
||||||
notarius:
|
|
||||||
credentials:
|
|
||||||
- OPENROUTER_API_KEY
|
|
||||||
```
|
|
||||||
|
|
||||||
Resolve references through the existing configuration/secret-loading mechanism
|
Keep full Audita debug bundles local in this feature. Preserve existing declared
|
||||||
before adapter execution, preserving its nonempty-value requirement. Forward
|
diagnostic publication and apply the workspace roadmap's retention protection
|
||||||
the captured values rather than rereading the parent environment during a run.
|
to latest link targets. This feature inherits that roadmap's clean session
|
||||||
Retain the minimal child execution environment plus each adapter's explicit
|
cutover and unchanged treatment of older completed outputs after invalidation
|
||||||
credential list; do not forward every secret found during bootstrap.
|
or failed replacement.
|
||||||
|
|
||||||
Audita backends select these names through `credential`; the current Notarius
|
### Documentation and verification
|
||||||
PromptKit profiles select them through `api_key_env`. Narratio neither inspects
|
|
||||||
downstream configuration to infer required credentials nor translates names,
|
|
||||||
registers providers, or duplicates backend configuration. Audita resolves
|
|
||||||
credentials for every surviving configured backend, even one not selected by
|
|
||||||
a profile, so its list must cover all those references.
|
|
||||||
|
|
||||||
Generalize Notarius's current single-name forwarding and replace Audita's fixed
|
When implemented, update the configuration reference and examples, Audita
|
||||||
`AUDITA_LLM_API_KEY` destination with this shared convention. Use existing shared
|
integration contract, polish internals, and operator guide. Reference Audita v3's
|
||||||
secret and subprocess facilities, extending narrow helpers where needed rather
|
profile migration and explain the shared Audita/Notarius overlay development
|
||||||
than introducing a new secret-management framework. Register every forwarded
|
workflow. Downstream configuration edits behind unchanged selectors still
|
||||||
credential with captured-output redaction, including custom names and multiple
|
require explicitly forcing the affected stage to replace reused outputs.
|
||||||
keys. Values must not enter arguments, generated configuration, manifests,
|
|
||||||
logs, or examples. As today, downstream tools remain responsible for files they
|
|
||||||
write directly; this does not add arbitrary downstream-file scanning.
|
|
||||||
|
|
||||||
## Ordinary reports and result handling
|
Revise the workspace roadmap's upstream-request description when this adoption
|
||||||
|
is incorporated; Audita v3.0.0 supplies the previously missing capability.
|
||||||
|
|
||||||
Replace the old `audita.report.json` handling with Audita's normal `errors.yml`,
|
Use focused offline tests for separate transcript/report/debug destinations,
|
||||||
`recoveries.yml`, and `report.md` bundle. With a file output, Audita writes these
|
enable-only debug selection, capture enabled by downstream configuration,
|
||||||
beside the corrected transcript; an arbitrary report destination is not supplied
|
available failure reports, and preservation of nonzero-exit behavior. Verify
|
||||||
through the removed report flag.
|
that reports remain diagnostics and only a successful validated transcript is
|
||||||
|
promoted. Shared latest-view and cleanup tests belong to the workspace change.
|
||||||
Discover the reports at their defined run-local locations and retain them as
|
Default Narratio tests use subprocess doubles and temporary filesystems and
|
||||||
diagnostics using Narratio's existing manifest and diagnostic lifecycle. Keep
|
remain independent of sibling checkouts, real credentials, and paid providers.
|
||||||
them distinguishable from the canonical polished transcript. Adapt report
|
|
||||||
references, publication/restore coverage, and operator inspection guidance so
|
|
||||||
the bundle is not lost or confused with an older run's JSON report. Do not
|
|
||||||
fabricate a legacy JSON report or delete historical diagnostics as part of the
|
|
||||||
migration.
|
|
||||||
|
|
||||||
Retain existing bounded, confined file handling. Replace JSON-specific report
|
|
||||||
handling with only the validation needed for consuming the v2 bundle; do not
|
|
||||||
introduce a second comprehensive report-schema validator or make incidental
|
|
||||||
Markdown wording a contract. Report locations must be discoverable without
|
|
||||||
parsing human-readable stderr. Detailed report-counter ingestion is not required
|
|
||||||
for this migration.
|
|
||||||
|
|
||||||
Audita's exit status remains authoritative. Exit zero with a valid corrected
|
|
||||||
transcript may include recoverable LLM failures, including a normalized result
|
|
||||||
with no model corrections. Preserve the reports so operators can assess that
|
|
||||||
outcome; do not add an unrequested fail-on-recovery or minimum-correction policy.
|
|
||||||
|
|
||||||
Conversely, a nonzero exit must fail polish even if a transcript file exists:
|
|
||||||
Audita can fail while writing required reports after writing the transcript.
|
|
||||||
Preserve available failure diagnostics without requiring early failures to have
|
|
||||||
produced a complete report bundle. Failed output must not become the canonical
|
|
||||||
successful result.
|
|
||||||
|
|
||||||
## Resume and semantic evidence
|
|
||||||
|
|
||||||
Update polish's semantic evidence for the new result-affecting selections and
|
|
||||||
remove retired endpoint/model fields. Include explicit config/overlay/profile
|
|
||||||
selection and preserve ordered module semantics, including omitted versus empty
|
|
||||||
selection. Version the changed evidence so incompatible older evidence is not
|
|
||||||
mistaken for a valid match when polish is considered for reuse.
|
|
||||||
|
|
||||||
Keep the existing boundary for opaque downstream configuration: Narratio does
|
|
||||||
not recursively hash Audita configuration, overlays, and profile contents.
|
|
||||||
Operators force polish when changing contents behind unchanged selectors.
|
|
||||||
Timeouts, credential values, reporting details, and other execution-only settings
|
|
||||||
must not become blanket semantic invalidation keys. Do not rerun unrelated or
|
|
||||||
unselected stages merely because the integration was upgraded.
|
|
||||||
|
|
||||||
## Migration guidance and verification
|
|
||||||
|
|
||||||
Update the canonical [configuration reference](../config.md),
|
|
||||||
[Audita integration contract](../integrations/audita.md),
|
|
||||||
[Notarius integration contract](../integrations/notarius.md),
|
|
||||||
[polish internals](../internal/stage-polish.md), maintained examples, and relevant
|
|
||||||
operations/troubleshooting guidance when implementation lands. Cover:
|
|
||||||
|
|
||||||
- Moving selected Narratio pipeline files to `overlays/`, replacing `--profile`
|
|
||||||
with `--overlay`, and distinguishing configuration overlays from model profiles.
|
|
||||||
- Updating ConfigKit API/source attribution and verifying unchanged effective
|
|
||||||
values retain existing semantic reuse behavior.
|
|
||||||
- Preparing and validating an Audita v2 configuration and its profiles before
|
|
||||||
switching the executable; copying an old v1 configuration is insufficient.
|
|
||||||
- Moving endpoint, model, capacity, and credential selections to their v2 owners.
|
|
||||||
- Replacing both singular `llm_api_key` settings with explicit `credentials`
|
|
||||||
lists, storing each provider key once, and matching downstream credential
|
|
||||||
references to those names. State clearly that old fields are removed.
|
|
||||||
- Using normal reports to inspect recoveries and failures without debug mode.
|
|
||||||
- Force/resume expectations and the treatment of existing completed sessions.
|
|
||||||
- The explicitly deferred nature of Narratio testing-profile debug support.
|
|
||||||
|
|
||||||
Verification should exercise the real adapter boundary with offline subprocess
|
|
||||||
fixtures and focused stage/configuration tests: accepted v2 arguments, omitted
|
|
||||||
defaults, ordered/empty modules, secret-safe forwarding, successful report
|
|
||||||
capture, recoverable-error success, nonzero exit with an existing transcript,
|
|
||||||
failure diagnostics, and semantic reuse/invalidation. Update existing behavioral
|
|
||||||
tests rather than retaining assertions for removed flags or exact stderr prose.
|
|
||||||
Where practical, verify invocation against the tagged Audita CLI without live
|
|
||||||
provider calls. Follow the repository's testing and documentation policies.
|
|
||||||
|
|
||||||
Credential tests must cover both adapters, multiple custom names, reuse of one
|
|
||||||
secret by both tools, no forwarding of unselected secrets, captured-value
|
|
||||||
semantics, and redaction of every forwarded value. Verify removal of obsolete
|
|
||||||
configuration fields without preserving their compatibility behavior.
|
|
||||||
|
|
||||||
## Scope boundaries
|
|
||||||
|
|
||||||
No changes to pipeline order, transcript identity, downstream artifact
|
|
||||||
definitions, or provider algorithms are intended. No automatic v1 configuration
|
|
||||||
converter, Audita-internal resume mechanism, runtime binary-version negotiation,
|
|
||||||
or live-service release gate is required. Debug-profile integration and ingestion
|
|
||||||
of Audita's debug-only execution artifacts are future work.
|
|
||||||
|
|
||||||
The Notarius change is limited to credential configuration, forwarding, and
|
|
||||||
associated diagnostics/documentation/tests; extraction and cache behavior are
|
|
||||||
unchanged. This migration breaks existing pipeline configurations using removed
|
|
||||||
fields; account for that explicitly in Narratio release versioning.
|
|
||||||
|
|||||||
720
docs/roadmap/commandkit-notepad.md
Normal file
720
docs/roadmap/commandkit-notepad.md
Normal file
@@ -0,0 +1,720 @@
|
|||||||
|
# CommandKit migration notepad
|
||||||
|
|
||||||
|
Status: discussion decisions recorded; ready for roadmap consolidation.
|
||||||
|
Started 2026-11-19.
|
||||||
|
|
||||||
|
Narratio will become a CommandKit-native application. This notepad collects the
|
||||||
|
agreed direction, open questions, and subsequent decisions before they are
|
||||||
|
consolidated into a feature roadmap. It is not an implementation plan or a
|
||||||
|
description of current Narratio behavior.
|
||||||
|
|
||||||
|
## Agreed direction
|
||||||
|
|
||||||
|
### Full native cutover
|
||||||
|
|
||||||
|
Adopt CommandKit's public-facing conventions and recommendations to the fullest
|
||||||
|
extent. Backward compatibility with Narratio's existing CLI conventions is a
|
||||||
|
non-goal. Provide migration guidance in release documentation so operators can
|
||||||
|
update their commands and scripts.
|
||||||
|
|
||||||
|
Use native command declarations, typed inputs, routing, help, version,
|
||||||
|
reporting, and outcome handling. Adopt upstream parsing and presentation
|
||||||
|
semantics rather than building compatibility parsers, legacy output modes, or
|
||||||
|
status translations to reproduce the existing CLI.
|
||||||
|
|
||||||
|
Consequently, differences in repeated-flag handling, option placement, help,
|
||||||
|
version output, configuration comparison syntax, and exit classification are
|
||||||
|
migration topics to explain, not legacy behavior to preserve. Existing command
|
||||||
|
names and shortcuts may survive when they remain useful domain operations;
|
||||||
|
their historical existence alone does not require retaining them.
|
||||||
|
|
||||||
|
### Modules and ownership
|
||||||
|
|
||||||
|
Plan adoption of CommandKit core and its ConfigKit integration, `ckconfig`.
|
||||||
|
Use the standard inspection capabilities where they apply to Narratio's
|
||||||
|
configuration. Generated help and shell completion belong in the direction
|
||||||
|
for the cutover.
|
||||||
|
|
||||||
|
ConfigKit owns configuration policy and the lifecycle through the final,
|
||||||
|
fully resolved configuration handoff. Narratio supplies its configuration
|
||||||
|
schema, domain defaults, validation, and genuine configuration-resolution
|
||||||
|
rules through ConfigKit's supported extension points. Those callbacks operate
|
||||||
|
within ConfigKit's lifecycle and provenance model.
|
||||||
|
|
||||||
|
Narratio owns interpreting the handed-off configuration and using it for
|
||||||
|
pipeline orchestration, artifact selection, manifests, resume, publishing,
|
||||||
|
restore, and cleanup. CommandKit owns CLI mechanics and presentation;
|
||||||
|
`ckconfig` exposes ConfigKit's inspection features through native adapters.
|
||||||
|
Narratio provides neutral command declarations, selection, and acquisition
|
||||||
|
wiring rather than an intervening configuration or inspection policy layer.
|
||||||
|
|
||||||
|
Keep `ckprompt` and direct PromptKit engine ownership outside this migration.
|
||||||
|
Narratio delegates prompt execution to Scriptorium. Prompt-requirements
|
||||||
|
inspection and early pipeline dependency checks remain separate feature work
|
||||||
|
using an eventual Scriptorium external contract. CommandKit adoption can
|
||||||
|
proceed independently.
|
||||||
|
|
||||||
|
### Configuration handoff and domain interpretation
|
||||||
|
|
||||||
|
The completed ConfigKit result is authoritative configuration. Consume it
|
||||||
|
without post-handoff mutation. Any genuine configuration defaulting,
|
||||||
|
normalization, or resolution must complete within ConfigKit's supported
|
||||||
|
lifecycle before handoff, with native evidence. If a required capability is
|
||||||
|
missing, identify the specific upstream gap instead of implementing a second
|
||||||
|
configuration system in Narratio.
|
||||||
|
|
||||||
|
Domain interpretation produces separate domain objects. For example, Narratio
|
||||||
|
can interpret artifact-family declarations and a party roster to produce a
|
||||||
|
concrete artifact catalog, execution plan, and publication actions. It must
|
||||||
|
not write those products back into the resolved configuration or present them
|
||||||
|
as a replacement effective configuration. Domain derivation remains Narratio's
|
||||||
|
responsibility; it does not need to be moved into configuration callbacks merely
|
||||||
|
to appear in standard inspection output.
|
||||||
|
|
||||||
|
Standard inspection uses the genuine ConfigKit result through native
|
||||||
|
`ckconfig` adapters. Do not construct a separate effective inspection document,
|
||||||
|
combine it with another result's authoring evidence, or add custom path or
|
||||||
|
provenance reconciliation. Native inspection and override semantics are
|
||||||
|
upstream contracts that Narratio exposes neutrally.
|
||||||
|
|
||||||
|
### Command organization
|
||||||
|
|
||||||
|
Use one general execution command, one regeneration convenience, and command
|
||||||
|
families for session operations and configuration:
|
||||||
|
|
||||||
|
```text
|
||||||
|
narratio
|
||||||
|
├── run SESSION
|
||||||
|
├── regenerate-artifacts SESSION
|
||||||
|
├── session
|
||||||
|
│ ├── init SESSION
|
||||||
|
│ ├── plan SESSION
|
||||||
|
│ ├── validate SESSION
|
||||||
|
│ ├── status SESSION
|
||||||
|
│ ├── restore SESSION
|
||||||
|
│ ├── clean [SESSION | --all]
|
||||||
|
│ ├── artifacts SESSION
|
||||||
|
│ └── locks
|
||||||
|
│ ├── list SESSION
|
||||||
|
│ ├── add SESSION SOURCE
|
||||||
|
│ └── remove SESSION SOURCE
|
||||||
|
├── config
|
||||||
|
│ ├── scopes
|
||||||
|
│ ├── validate
|
||||||
|
│ ├── show
|
||||||
|
│ ├── sources
|
||||||
|
│ ├── explain
|
||||||
|
│ ├── diff
|
||||||
|
│ └── artifacts
|
||||||
|
├── version
|
||||||
|
├── completion
|
||||||
|
└── help
|
||||||
|
```
|
||||||
|
|
||||||
|
`run SESSION` selects the full pipeline by default. `--from` and `--through`
|
||||||
|
select an inclusive contiguous range. Add `--stage` for one stage, mutually
|
||||||
|
exclusive with the range selectors; it selects the same stage as both endpoints.
|
||||||
|
`--force` independently requests forced execution. `session plan` accepts the
|
||||||
|
same execution-selection options, including stage/range, force, and artifacts.
|
||||||
|
|
||||||
|
Use positional session IDs on session-oriented commands and remove their
|
||||||
|
duplicate `--session-id` spelling. Campaign and configuration selection remain
|
||||||
|
flags, with spelling defined below.
|
||||||
|
|
||||||
|
Remove `run-stage`, `analyze`, and `publish`. Single-stage execution uses
|
||||||
|
`run --stage`; forced regeneration adds `--force` explicitly. Move top-level
|
||||||
|
`clean` to `session clean`. Use the explicit `session locks list` operation so
|
||||||
|
the bare locks group displays native help.
|
||||||
|
|
||||||
|
Keep `regenerate-artifacts` as an application-owned command sharing execution
|
||||||
|
logic. Its useful domain intent is forced extraction through analysis without
|
||||||
|
publication. It regenerates the complete configured extraction bundle;
|
||||||
|
`--artifacts` selects analysis targets and their required prerequisites, not
|
||||||
|
extraction lanes. The command name makes regeneration explicit.
|
||||||
|
|
||||||
|
`config artifacts` remains a Narratio-specific catalog alongside the standard
|
||||||
|
ckconfig operations, with the view defined below.
|
||||||
|
|
||||||
|
### Configuration scopes and views
|
||||||
|
|
||||||
|
Expose four scopes corresponding to Narratio's configuration domains. Use `app`
|
||||||
|
as the native default scope.
|
||||||
|
|
||||||
|
| Scope | Native ConfigKit configuration result |
|
||||||
|
| --- | --- |
|
||||||
|
| `app` | Resolved application/pipeline configuration |
|
||||||
|
| `campaign` | The selected campaign's settings |
|
||||||
|
| `session` | The selected session's settings, with applicable configuration defaults resolved within ConfigKit's lifecycle |
|
||||||
|
| `party` | The party configuration selected by `--party-file` or the campaign default |
|
||||||
|
|
||||||
|
Expose standard `show`, `diff`, `sources`, `explain`, and `validate` behavior
|
||||||
|
through native `ckconfig` adapters for each scope's ConfigKit result. Effective
|
||||||
|
values, provenance, history, validation findings, and path behavior come from
|
||||||
|
that result and the upstream integration. Narratio supplies domain validation
|
||||||
|
through the supported ConfigKit lifecycle, not a separate inspection policy.
|
||||||
|
|
||||||
|
Remove the earlier requirement that app show/diff include expanded artifacts
|
||||||
|
and generated publish rules. They display and compare whatever the genuine
|
||||||
|
ConfigKit result contains. Domain products derived after handoff are not added
|
||||||
|
to standard inspection, and differences between those products are not added
|
||||||
|
to native configuration comparisons. A separate raw-versus-resolved mode is
|
||||||
|
not part of the design.
|
||||||
|
|
||||||
|
Keep `config artifacts` as a Narratio-owned domain catalog of concrete artifact
|
||||||
|
definitions and dependencies derived from the handed-off configuration and
|
||||||
|
selected party. Planning commands describe derived execution and publication
|
||||||
|
work. These domain views do not redefine ConfigKit's effective configuration.
|
||||||
|
`session artifacts SESSION` reports session-specific availability and
|
||||||
|
publication state. Future input discovery can extend the domain catalog
|
||||||
|
separately from this migration.
|
||||||
|
|
||||||
|
Acquire only the context needed for the selected scope's native configuration
|
||||||
|
load. Applicable campaign defaults for session configuration resolve before
|
||||||
|
handoff. Standard app inspection does not acquire campaign/party context solely
|
||||||
|
to expand runtime artifacts. Domain catalog and planning operations acquire
|
||||||
|
the additional context needed for domain work. Campaign inspection does not
|
||||||
|
require a session. Scope discovery and help do not load configuration. Report
|
||||||
|
missing required context explicitly rather than presenting an incomplete load
|
||||||
|
as a complete configuration result.
|
||||||
|
|
||||||
|
Retain CommandKit's operation-specific `--scope all` behavior. Do not silently
|
||||||
|
omit a selected scope whose required context is missing.
|
||||||
|
|
||||||
|
Comparisons use independently resolved left and right selections through native
|
||||||
|
selectors and their `--against-*` counterparts. Permit comparisons across
|
||||||
|
overlays, configuration files, and campaigns; the existing same-campaign
|
||||||
|
restriction is not retained.
|
||||||
|
|
||||||
|
### Session acquisition and selectors
|
||||||
|
|
||||||
|
Inspection and execution use the same session-selection rules. Load an explicit
|
||||||
|
session file exactly when supplied; otherwise use normal local discovery, then
|
||||||
|
configured remote discovery when no local session exists and its identity is
|
||||||
|
known. Missing or invalid explicit files are errors. Invalid content, access
|
||||||
|
failures, and identity mismatches do not trigger fallback to another source.
|
||||||
|
|
||||||
|
Remote discovery prefers the authored session-root configuration and falls back
|
||||||
|
to the committed prepared snapshot only when the authored object is absent.
|
||||||
|
Configuration inspection permits these network reads without requiring a
|
||||||
|
separate remote opt-in. It creates no local runtime state: no workspace
|
||||||
|
initialization, restored files, execution locks, or manifest changes. Source
|
||||||
|
inspection identifies local, remote-authored, and committed-snapshot origins.
|
||||||
|
Forced-local or forced-remote selection is not part of the initial design.
|
||||||
|
|
||||||
|
| Selector | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| `--config PATH` | Pipeline configuration root for every scope |
|
||||||
|
| `--overlay NAME` | Pipeline overlay |
|
||||||
|
| `--campaign ID` | Campaign identity |
|
||||||
|
| `--campaign-file PATH` | Explicit campaign configuration file |
|
||||||
|
| `--session ID` | Session identity on configuration inspection commands |
|
||||||
|
| `--session-file PATH` | Explicit session configuration file |
|
||||||
|
| `--party-file PATH` | Explicit party roster file in place of the campaign default |
|
||||||
|
| `--secrets-dir PATH` | Credential-bootstrap directory selection |
|
||||||
|
|
||||||
|
Changing scope does not change the meaning of `--config`. Session-oriented
|
||||||
|
commands retain their positional session identity and can also select an
|
||||||
|
explicit source using `--session-file`.
|
||||||
|
|
||||||
|
Identity and file selectors are complementary: the file selects the source and
|
||||||
|
an accompanying ID asserts the intended identity. Check that assertion against
|
||||||
|
the effective configuration after loading and resolution; mismatches fail
|
||||||
|
clearly.
|
||||||
|
For inspection, the file can supply identity when no identity selector is
|
||||||
|
given; session-oriented commands retain their required positional identity.
|
||||||
|
|
||||||
|
The campaign supplies the default party file. `--party-file` selects an alternate
|
||||||
|
roster for the invocation without editing the campaign or its usual roster.
|
||||||
|
Resolve CLI-relative paths from the invocation directory and load an explicit
|
||||||
|
file exactly; a missing or invalid selected file fails rather than falling back
|
||||||
|
to the campaign default. Apply the same selection throughout inspection,
|
||||||
|
players derivation, artifact expansion, planning, and execution. Source evidence
|
||||||
|
identifies the selected roster and its imports.
|
||||||
|
|
||||||
|
Comparisons expose `--against-campaign`, `--against-campaign-file`,
|
||||||
|
`--against-session`, `--against-session-file`, and `--against-party-file`
|
||||||
|
alongside CommandKit's native right-side configuration selectors. Omitted
|
||||||
|
right-side selectors use normal defaults rather than inheriting left-side
|
||||||
|
values, including each side's campaign-default party file.
|
||||||
|
|
||||||
|
### Configuration inspection capabilities
|
||||||
|
|
||||||
|
Enable the full applicable native inspection capabilities across the four
|
||||||
|
configuration scopes:
|
||||||
|
|
||||||
|
- path-selected show using JSON Pointer syntax;
|
||||||
|
- explanation and path discovery, including available history and provenance;
|
||||||
|
- detailed validation findings with native severity and code filters;
|
||||||
|
- detailed comparisons with before/after values and presence information; and
|
||||||
|
- native `diff --check`, including status `3` when differences exist.
|
||||||
|
|
||||||
|
These capabilities use upstream operations and evidence from the scope's native
|
||||||
|
result. Filtering findings changes presentation, not validation success.
|
||||||
|
ConfigKit owns the relationship between effective, historical, explainable,
|
||||||
|
and overridable paths; Narratio does not add a writable-path registry,
|
||||||
|
reinterpret explicitness, or manufacture provenance for domain products.
|
||||||
|
|
||||||
|
### Native application configuration overrides
|
||||||
|
|
||||||
|
Support invocation-local field overrides only for the `app` scope, with
|
||||||
|
equivalent application configuration selections available to app inspection,
|
||||||
|
planning, and execution. Campaign, session, and party scopes retain their
|
||||||
|
inspection capabilities; alternate inputs use `--campaign-file`,
|
||||||
|
`--session-file`, and `--party-file`.
|
||||||
|
|
||||||
|
CommandKit supplies the `POINTER=JSON` flag grammar; ConfigKit applies its native
|
||||||
|
override mechanism to application configuration. Do not introduce additional
|
||||||
|
protected-field lists, custom merge semantics, or a separate override acceptance
|
||||||
|
policy within that scope.
|
||||||
|
|
||||||
|
Use these flag spellings:
|
||||||
|
|
||||||
|
| Flag | Target |
|
||||||
|
| --- | --- |
|
||||||
|
| `--set POINTER=JSON` | App/pipeline configuration on app inspection, planning, and execution |
|
||||||
|
| `--against-set POINTER=JSON` | Right-side app/pipeline configuration on app comparisons |
|
||||||
|
|
||||||
|
Declare native override support only for `app`. Other inspection scopes do not
|
||||||
|
accept `--set`; native `--scope all` also rejects overrides because not every
|
||||||
|
selected scope supports them. Aggregate inspection without overrides remains
|
||||||
|
available as supported by each operation. Do not add scope-specific `--set-*`
|
||||||
|
or `--against-set-*` aliases, cross-scope override dispatch, or scope prefixes
|
||||||
|
inside JSON Pointers.
|
||||||
|
|
||||||
|
The additional convenience of modifying a discovered input without preparing a
|
||||||
|
file does not justify field overrides for the other domains in this migration.
|
||||||
|
File selection can supply the same effective domain values, although its
|
||||||
|
authoring and provenance differ from late CLI overrides. This decision removes
|
||||||
|
the need to compose overrides across supporting domains or reconcile generic
|
||||||
|
and explicitly targeted override flags.
|
||||||
|
|
||||||
|
ConfigKit applies overrides after typed defaults and decoding, before its
|
||||||
|
resolution and semantic validation callbacks. Preserve native explicit empty,
|
||||||
|
false, zero, and null values, mapping merge and whole-sequence replacement, and
|
||||||
|
duplicate/overlapping-path rejection. Earlier parsing and decoding failures
|
||||||
|
remain errors. CommandKit's last-value convention for singleton flags does not
|
||||||
|
replace ConfigKit's conflict rules for override records.
|
||||||
|
|
||||||
|
Override paths and acceptance follow ConfigKit's native input semantics for
|
||||||
|
application configuration. Standard inspection does not promise that every
|
||||||
|
displayed path accepts an override. Narratio passes explicit assignments to
|
||||||
|
ConfigKit without translating runtime catalog paths into input paths or
|
||||||
|
patching domain products after handoff.
|
||||||
|
|
||||||
|
Overrides leave source configuration files unchanged. Normal run metadata and
|
||||||
|
prepared configuration may record the effective settings through established
|
||||||
|
secret-safe representations. Reuse decisions continue to depend on semantic
|
||||||
|
evidence: result-affecting changes can require regeneration, while the presence
|
||||||
|
of an override alone does not force execution.
|
||||||
|
|
||||||
|
### Identity assertions and credential overrides
|
||||||
|
|
||||||
|
Narratio checks the effective campaign/session identity against any explicitly
|
||||||
|
asserted identity after loading and resolution so an operation targeting one
|
||||||
|
session cannot silently use another session's workspace, lock, manifest, or
|
||||||
|
remote destination. This is an ordinary domain consistency check, independent
|
||||||
|
of the selected source. Alternate campaign and session values come from file
|
||||||
|
selection rather than field overrides. App overrides retain native acceptance
|
||||||
|
without a protected-field list.
|
||||||
|
|
||||||
|
When no identity is asserted, such as inspection of an explicit session file
|
||||||
|
without `--session`, the effective document supplies its identity.
|
||||||
|
Session-oriented commands retain their required positional assertion.
|
||||||
|
|
||||||
|
Credential-related app fields accept native overrides and use ConfigKit's
|
||||||
|
ordinary typed-secret handling and normal configuration validation. Safe
|
||||||
|
inspection, diagnostics, and persistence remain separate output
|
||||||
|
responsibilities; they do not justify additional restrictions on which app
|
||||||
|
fields may be overridden.
|
||||||
|
|
||||||
|
### Reports and machine-readable output
|
||||||
|
|
||||||
|
Use CommandKit's native reporting system throughout. Produce one structured
|
||||||
|
result per invocation where the command has a meaningful result, keeping
|
||||||
|
progress and diagnostics separate. Standard ckconfig commands retain their
|
||||||
|
native report shapes; Narratio defines report values for its domain operations.
|
||||||
|
|
||||||
|
| Command family | Report content |
|
||||||
|
| --- | --- |
|
||||||
|
| `run`, `regenerate-artifacts` | Campaign/session identity, selected stages, execution or reuse outcomes, generated artifacts, and completion status |
|
||||||
|
| `session plan` | Selected stages, planned execution/reuse decisions and reasons, artifact targets, and prerequisites |
|
||||||
|
| `session status` | Local stage state and available remote publication information |
|
||||||
|
| Artifact catalogs | Source identities, producers, dependencies, and session-specific availability/publication where applicable |
|
||||||
|
| `session validate` | Overall outcome and individual findings |
|
||||||
|
| `session restore`, `session clean` | Planned or completed actions, conflicts, and dry-run status |
|
||||||
|
| Session initialization and lock mutations | Concise confirmation identifying the affected session, destination, or lock |
|
||||||
|
|
||||||
|
Support native `--format text|yaml|json` conventions. Start with native automatic
|
||||||
|
presentation, including YAML for structured values. Add a custom text template
|
||||||
|
only when representative output demonstrates a substantial readability benefit.
|
||||||
|
The template presents the same report value rather than a separate information
|
||||||
|
model; recreating the existing handwritten text output is not a goal.
|
||||||
|
|
||||||
|
Long-running operations emit progress through the diagnostic channel and their
|
||||||
|
final report through the result channel, allowing JSON results to be captured
|
||||||
|
without progress mixed into the document. A streaming JSON event protocol is
|
||||||
|
deferred as a separate interface.
|
||||||
|
|
||||||
|
When execution stops after meaningful domain work, report what completed and
|
||||||
|
where work stopped alongside the failed command outcome. Preserve the success
|
||||||
|
of earlier durable work. Failures before meaningful domain work, such as invalid
|
||||||
|
arguments, need only the native error; do not manufacture an empty run report.
|
||||||
|
Report-delivery failure follows CommandKit's native handling and does not undo
|
||||||
|
completed pipeline work.
|
||||||
|
|
||||||
|
Define public report values separately from internal structs and durable
|
||||||
|
manifests. Expose information useful to operators and callers without making
|
||||||
|
the entire internal state or manifest schema the CLI contract. Document
|
||||||
|
application-owned report fields as a public interface. An additional schema
|
||||||
|
version mechanism is not part of the initial design; review native report
|
||||||
|
changes during dependency upgrades.
|
||||||
|
|
||||||
|
`--format` controls the command report, not the format of generated artifacts.
|
||||||
|
For example, session initialization still writes its YAML configuration when
|
||||||
|
the confirmation report uses JSON.
|
||||||
|
|
||||||
|
### Diagnostics and invocation lifecycle
|
||||||
|
|
||||||
|
Adopt CommandKit's native visibility rules. Ordinary mode shows results and
|
||||||
|
failures; warnings and information require verbose/debug mode. Progress requires
|
||||||
|
`--progress` or debug mode. Quiet suppresses successful results and progress
|
||||||
|
while retaining failures. Conditions that materially affect the result also
|
||||||
|
belong in its structured report rather than depending solely on warning
|
||||||
|
visibility.
|
||||||
|
|
||||||
|
Classify Narratio's messages by their purpose:
|
||||||
|
|
||||||
|
| Category | Examples |
|
||||||
|
| --- | --- |
|
||||||
|
| Result | Final execution summary, plan, status, or configuration report |
|
||||||
|
| Failure | Failed stage, invalid configuration, or unavailable required input |
|
||||||
|
| Warning | Recoverable problem worth investigating |
|
||||||
|
| Information | Configuration selection or successful credential-bootstrap summary |
|
||||||
|
| Progress | Stage started/completed, artifact completed, or prior work reused |
|
||||||
|
| Debug | Additional safe acquisition or execution detail |
|
||||||
|
|
||||||
|
CommandKit owns console presentation: results go to stdout and diagnostics and
|
||||||
|
progress go to stderr. Domain operations return results and errors without
|
||||||
|
independently printing duplicate terminal failures at several layers. Preserve
|
||||||
|
downstream stdout/stderr in existing captured diagnostic logs; console output
|
||||||
|
provides concise context and useful log locations instead of automatically
|
||||||
|
replaying downstream output.
|
||||||
|
|
||||||
|
Durable logs and checkpoints retain their own policies. Quiet does not disable
|
||||||
|
logging or persistence. Debug increases diagnostic visibility without
|
||||||
|
automatically enabling downstream prompt-rendering/debug artifacts. Reporting
|
||||||
|
modes do not change pipeline selection, execution, or retention.
|
||||||
|
|
||||||
|
Keep startup lightweight and acquire dependencies only when needed:
|
||||||
|
|
||||||
|
1. Parse the command and validate syntax and input combinations.
|
||||||
|
2. Bootstrap credentials when the operation needs configuration.
|
||||||
|
3. Load the required configuration through ConfigKit's completed lifecycle,
|
||||||
|
then derive the domain context needed by the operation.
|
||||||
|
4. Acquire execution resources and perform the operation.
|
||||||
|
5. Finalize domain state, release resources, present the result, and return the
|
||||||
|
outcome.
|
||||||
|
|
||||||
|
Help, version, completion, and scope discovery do not bootstrap secrets, load
|
||||||
|
configuration, contact storage, or initialize stage adapters. Configuration-
|
||||||
|
dependent validation happens after loading; syntactic errors fail before it.
|
||||||
|
Session inspection may perform the already-agreed remote reads when needed.
|
||||||
|
|
||||||
|
The process boundary supplies an invocation context canceled by Ctrl-C or
|
||||||
|
termination. Propagate that context through CommandKit and Narratio operations.
|
||||||
|
On cancellation, stop scheduling further work, cancel active operations, and
|
||||||
|
let existing adapters perform their resource/subprocess shutdown. Attempt the
|
||||||
|
appropriate terminal manifest update and release held locks, preserve completed
|
||||||
|
checkpoints, and report meaningful partial results. Report persistence or
|
||||||
|
shutdown errors alongside the originating cancellation. Cancellation does not
|
||||||
|
invoke the pipeline cleanup stage or delete resumable work. Abrupt process
|
||||||
|
death is not guaranteed to permit finalization.
|
||||||
|
|
||||||
|
Use native outcome classification: success is `0`; operational failure,
|
||||||
|
cancellation, and output failure use `1`; invalid invocation or identifiable
|
||||||
|
configuration input uses `2`; `diff --check` uses `3` when differences exist.
|
||||||
|
Use public configuration-error classification support rather than matching
|
||||||
|
error strings. Failure explanations identify the affected operation and useful
|
||||||
|
next steps while retaining underlying error identity for programmatic access.
|
||||||
|
|
||||||
|
Include native completion for command paths, flags, static stage/scope values,
|
||||||
|
and appropriate file/directory selectors. Dynamic campaign and artifact
|
||||||
|
suggestions requiring configuration loading or storage access remain deferred.
|
||||||
|
|
||||||
|
### Delivery and migration guidance
|
||||||
|
|
||||||
|
Deliver one complete native CLI cutover through a single end-to-end
|
||||||
|
implementation sprint. Optimize the work sequence and commits for efficiently
|
||||||
|
reaching the intended final state. Intermediate commits may leave the overall
|
||||||
|
application incomplete, incoherent, or noncompiling; they are not independently
|
||||||
|
shippable units and do not require standalone application validation. Do not
|
||||||
|
introduce temporary compatibility machinery merely to keep each intermediate
|
||||||
|
commit working. Report intermediate status accurately, use focused checks when
|
||||||
|
useful, and require a coherent, compilable, fully validated final application.
|
||||||
|
|
||||||
|
Useful work boundaries are core invocation/domain commands; configuration
|
||||||
|
handoff, native scopes and inspection, file selection, and app overrides;
|
||||||
|
reports, diagnostics, cancellation, and completion; and integration
|
||||||
|
verification, removal of superseded CLI machinery, and documentation. These
|
||||||
|
are organizational boundaries, not mandatory buildable milestones or a
|
||||||
|
supported dual interface. The subsequent implementation plan determines the
|
||||||
|
most efficient order and dependencies.
|
||||||
|
|
||||||
|
Use CommandKit v0.7.0 and ckconfig v0.9.0 as the initial roadmap baseline.
|
||||||
|
Review relevant public contract changes before deliberately selecting a later
|
||||||
|
release. Before finalizing implementation details, verify native ConfigKit
|
||||||
|
loader and `ckconfig` adapter integration and composition of Narratio-specific
|
||||||
|
commands alongside standard configuration commands. Address required upstream
|
||||||
|
capability gaps upstream rather than compensating with custom effective views,
|
||||||
|
provenance reconciliation, or replacement configuration behavior.
|
||||||
|
|
||||||
|
Remove the current post-load configuration mutation and the split between
|
||||||
|
runtime inspection snapshots and authoring evidence. Separate domain products
|
||||||
|
from the authoritative configuration handoff while preserving their intended
|
||||||
|
processing behavior. Do not retain those inspection projections merely to
|
||||||
|
reproduce existing output. Safe persisted configuration and domain artifacts
|
||||||
|
remain useful records, but do not replace the result used by native inspection.
|
||||||
|
|
||||||
|
Retain Narratio's stage sequencing, resume authority, publication semantics,
|
||||||
|
restore safety, and cleanup rules. Changes required for the agreed ownership
|
||||||
|
boundary, inspection, overrides, reporting, and cancellation behavior are in
|
||||||
|
scope. Workspace reorganization, downstream-tool adoption, and Scriptorium
|
||||||
|
requirements inspection remain separate work.
|
||||||
|
|
||||||
|
Validate the integration through representative behavioral acceptance cases:
|
||||||
|
|
||||||
|
- Native arguments and selectors reach the intended Narratio operation.
|
||||||
|
- Standard configuration commands expose genuine ConfigKit results through
|
||||||
|
native adapters, with upstream value, provenance, and path semantics.
|
||||||
|
- Domain catalog and plan generation consume handed-off configuration without
|
||||||
|
modifying it or replacing the native inspection result.
|
||||||
|
- App inspection, planning, and execution resolve equivalent application
|
||||||
|
configuration selections and overrides.
|
||||||
|
- Explicit party-file selection consistently feeds roster inspection, derived
|
||||||
|
players, artifact expansion, planning, and execution; comparison sides remain
|
||||||
|
independent.
|
||||||
|
- Override capability is limited to app; other scopes and aggregate inspection
|
||||||
|
retain native behavior when overrides are unsupported.
|
||||||
|
- Reports remain separate from diagnostics and preserve meaningful partial
|
||||||
|
results.
|
||||||
|
- Help and completion avoid configuration and service acquisition.
|
||||||
|
- Cancellation reaches active work, preserves completed checkpoints, and
|
||||||
|
permits terminal persistence and lock release.
|
||||||
|
- Existing consequential pipeline behavior remains protected.
|
||||||
|
|
||||||
|
Use real CommandKit and ConfigKit with controlled external boundaries. Update
|
||||||
|
or retire tests enforcing superseded CLI conventions while retaining domain
|
||||||
|
behavior coverage. Final verification uses the repository's established checks
|
||||||
|
without requiring live services or model calls; do not duplicate upstream
|
||||||
|
generic parser or configuration tests. Dependency attribution is part of the
|
||||||
|
adoption work.
|
||||||
|
|
||||||
|
Provide workflow-oriented release migration guidance: an old-to-new command
|
||||||
|
table plus explanations of removed shortcuts, identity/file selectors including
|
||||||
|
party-file selection, app-only field overrides, native flag repetition and
|
||||||
|
placement, native configuration inspection and its distinction from domain
|
||||||
|
catalogs and plans, configuration comparisons, structured output, diagnostic
|
||||||
|
visibility, exit classifications, and cancellation. Identify affected examples,
|
||||||
|
operator procedures, scripts, and downstream callers.
|
||||||
|
Update canonical documentation and maintained examples as implementation lands;
|
||||||
|
release notes summarize and link to those contracts rather than duplicate the
|
||||||
|
command reference.
|
||||||
|
|
||||||
|
Select the Narratio release number under the release policy once the final
|
||||||
|
compatibility impact is known. No version or publication action is selected by
|
||||||
|
these planning decisions. Consolidate the agreed target behavior, boundaries,
|
||||||
|
migration impact, and acceptance criteria into a feature roadmap before preparing
|
||||||
|
the detailed implementation plan.
|
||||||
|
|
||||||
|
## Reviewed upstream baseline
|
||||||
|
|
||||||
|
The initial review covered these released modules:
|
||||||
|
|
||||||
|
| Module | Version | Relevant capability |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `go.maximumdirect.net/commandkit` | v0.7.0 | Typed commands and inputs, presence tracking, aliases, help/version, completion, reporting, and outcomes |
|
||||||
|
| `go.maximumdirect.net/ckconfig` | v0.9.0 | Configuration scopes, validation, safe display, sources, explanation, comparison, and optional overrides |
|
||||||
|
| `go.maximumdirect.net/ckprompt` | v0.10.0 | PromptKit inspection and request tooling; reviewed for context, outside adoption scope |
|
||||||
|
|
||||||
|
Core v0.7.0 and ckconfig v0.9.0 require Go 1.27.0; ckconfig selects ConfigKit
|
||||||
|
v1.2.1. Narratio already declares those Go and ConfigKit versions. CommandKit
|
||||||
|
identifies itself as alpha. The core and ckconfig versions above are the initial
|
||||||
|
roadmap baseline; revisit these references if that baseline deliberately changes.
|
||||||
|
|
||||||
|
Upstream references:
|
||||||
|
|
||||||
|
- [Consumer guide and module selection](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/d330d7637f2e7507eca931a899397222c82bc892/docs/consumers/guide.md)
|
||||||
|
- [Core CLI conventions](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/b57bfe176cff05a892e6cb07ebb5f350239e55d4/docs/cli.md)
|
||||||
|
- [ConfigKit integration public contracts](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/9962368f0c1ea1f6ad010638e94621091105d745/integrations/ckconfig/contracts.go)
|
||||||
|
|
||||||
|
Narratio's existing [CLI reference](../cli.md) and
|
||||||
|
[configuration internals](../internal/configuration.md) provide the current
|
||||||
|
baseline. They remain current-behavior documents until the migration lands.
|
||||||
|
|
||||||
|
## Open decisions
|
||||||
|
|
||||||
|
No unresolved discussion decisions are currently recorded. Public API fit
|
||||||
|
checks and detailed implementation sequencing remain preparation work for the
|
||||||
|
roadmap and subsequent plan. Release version selection remains deferred to
|
||||||
|
release preparation.
|
||||||
|
|
||||||
|
The configuration ownership boundary is recorded in
|
||||||
|
[ADR 0003](../adr/0003-assign-configuration-ownership.md). Roadmap consolidation
|
||||||
|
is the next planning step.
|
||||||
|
|
||||||
|
## Discussion and decision record
|
||||||
|
|
||||||
|
### 2026-11-19 — Initial direction
|
||||||
|
|
||||||
|
Accepted the direction of adopting core and ckconfig while keeping direct
|
||||||
|
PromptKit integration and Scriptorium requirements work separate. The initial
|
||||||
|
review identified command design, configuration views, reporting, and lifecycle
|
||||||
|
as the main discussion areas.
|
||||||
|
|
||||||
|
The user established full CommandKit-native cutover as the guiding decision:
|
||||||
|
adopt upstream public conventions and recommendations to the fullest extent,
|
||||||
|
provide release migration guidance, and treat existing CLI compatibility as a
|
||||||
|
non-goal. This settles the earlier question of whether to preserve legacy CLI
|
||||||
|
conventions.
|
||||||
|
|
||||||
|
### 2026-11-19 — Command organization agreed
|
||||||
|
|
||||||
|
Accepted the proposed command tree, `run --stage` selector, positional session
|
||||||
|
IDs, shared selection syntax for planning, explicit lock listing, and movement
|
||||||
|
of cleanup under `session`. Removed the separate single-stage and implicitly
|
||||||
|
forced analysis/publication commands from the target CLI. Retained
|
||||||
|
`regenerate-artifacts` because it expresses a useful multi-stage regeneration
|
||||||
|
workflow. Configuration scopes and views are the next discussion topic.
|
||||||
|
|
||||||
|
### 2026-11-19 — Configuration scopes and views agreed
|
||||||
|
|
||||||
|
The later configuration-ownership revision supersedes the expanded app
|
||||||
|
inspection view recorded below. The four scopes remain, with standard
|
||||||
|
inspection exposing their native ConfigKit results.
|
||||||
|
|
||||||
|
Accepted `app`, `campaign`, `session`, and `party` scopes, with `app` as default.
|
||||||
|
Show/diff exposes effective values and source/explanation operations use native
|
||||||
|
provenance. Concrete artifacts remain visible in the effective pipeline and the
|
||||||
|
separate configuration catalog; session artifact inspection owns availability.
|
||||||
|
Accepted context-dependent acquisition, explicit missing-context errors, native
|
||||||
|
aggregate-scope behavior, and independently resolved comparisons across
|
||||||
|
campaigns. Session acquisition policy and selector spelling are next.
|
||||||
|
|
||||||
|
### 2026-11-19 — Session acquisition and selectors agreed
|
||||||
|
|
||||||
|
Accepted shared inspection/execution discovery with automatic remote fallback,
|
||||||
|
read-only acquisition without local runtime state, and explicit source
|
||||||
|
provenance. Accepted distinct identity/file selectors, identity assertions when
|
||||||
|
both are supplied, campaign-owned party selection, and independent right-side
|
||||||
|
comparison selectors. Optional configuration capabilities and overrides are
|
||||||
|
the next discussion topic.
|
||||||
|
|
||||||
|
The later override-scope revision supersedes campaign-only party selection by
|
||||||
|
adding an explicit party-file selector while retaining the campaign default.
|
||||||
|
|
||||||
|
### 2026-11-19 — Configuration capabilities and overrides agreed
|
||||||
|
|
||||||
|
The cross-domain override decision below is superseded by the later
|
||||||
|
override-scope revision. Inspection capabilities and native app override
|
||||||
|
semantics remain accepted.
|
||||||
|
|
||||||
|
Accepted full applicable inspection capabilities and native overrides across
|
||||||
|
all four configuration domains, with parity across inspection, planning, and
|
||||||
|
execution. Selected verb-first `--set-app`, `--set-campaign`, `--set-session`,
|
||||||
|
and `--set-party` spellings and corresponding `--against-set-*` comparison
|
||||||
|
flags, alongside native `--set` and `--against-set`.
|
||||||
|
|
||||||
|
Clarified that overrides have no Narratio-specific protected fields or custom
|
||||||
|
merge semantics. Identity assertions are checked against effective values after
|
||||||
|
native overrides and resolution; they do not make identity fields immutable.
|
||||||
|
Credential overrides use native typed-secret handling. Safe output and
|
||||||
|
persistence do not impose additional override restrictions.
|
||||||
|
|
||||||
|
### 2026-11-19 — Reporting agreed
|
||||||
|
|
||||||
|
Accepted native structured reporting with one meaningful result document per
|
||||||
|
invocation, separate diagnostics/progress, and native ckconfig report shapes.
|
||||||
|
Custom text templates require a demonstrated readability benefit. Domain
|
||||||
|
reports describe partial execution on failure without undoing durable work;
|
||||||
|
early failures need no empty report. Report models remain separate from
|
||||||
|
manifests and generated artifact formats, with documented public fields and no
|
||||||
|
additional schema version mechanism initially. Streaming JSON events remain
|
||||||
|
deferred. Diagnostics and invocation lifecycle are the next discussion topic.
|
||||||
|
|
||||||
|
### 2026-11-19 — Diagnostics and invocation lifecycle agreed
|
||||||
|
|
||||||
|
Accepted native diagnostic categories, visibility, and outcome classification,
|
||||||
|
with CommandKit owning console presentation separately from durable logs.
|
||||||
|
Startup acquires only the resources needed by the selected operation. Process
|
||||||
|
signals cancel the invocation context, preserving completed checkpoints and
|
||||||
|
allowing ordinary terminal persistence and lock release without triggering
|
||||||
|
pipeline cleanup. Accepted static and filesystem completion, with dynamic
|
||||||
|
campaign/artifact suggestions deferred. Delivery and migration guidance remain
|
||||||
|
open.
|
||||||
|
|
||||||
|
### 2026-11-19 — Delivery and migration agreed
|
||||||
|
|
||||||
|
Accepted one complete native cutover, the reviewed release baseline, explicit
|
||||||
|
public API fit checks, domain-behavior preservation, focused integration
|
||||||
|
verification, and workflow-oriented migration guidance. Release version
|
||||||
|
selection and publication remain separate from planning.
|
||||||
|
|
||||||
|
The user specified a single end-to-end implementation sprint. Intermediate
|
||||||
|
commits need not leave the overall application coherent or compilable; their
|
||||||
|
purpose is to support efficient progress toward the final state. Coherence,
|
||||||
|
compilation, and full validation are required at completion, without imposing
|
||||||
|
independently shippable or fully validated intermediate milestones. All
|
||||||
|
currently discussed decision areas are settled for roadmap consolidation.
|
||||||
|
|
||||||
|
### 2026-11-19 — Override scope simplified and party-file selection added
|
||||||
|
|
||||||
|
Revisited the need for field overrides outside application configuration.
|
||||||
|
Accepted native `--set` and `--against-set` only for `app`, retaining inspection
|
||||||
|
of all four scopes and using file selectors for alternate campaign, session,
|
||||||
|
and party inputs. Removed the proposed scope-specific override flag families
|
||||||
|
and their cross-domain composition requirements. Native aggregate inspection
|
||||||
|
rejects overrides when the selected scopes do not all support them.
|
||||||
|
|
||||||
|
Added `--party-file` and independent `--against-party-file` selection. The
|
||||||
|
campaign continues to supply the default roster; an explicit file supplies the
|
||||||
|
invocation's roster consistently across inspection, derivation, planning, and
|
||||||
|
execution.
|
||||||
|
|
||||||
|
No identified workflow requires non-app field overrides. Their convenience does
|
||||||
|
not justify the additional interface and integration machinery. The intent is
|
||||||
|
to meaningfully reduce complexity while retaining native app override behavior
|
||||||
|
and ordinary file-backed configuration composition. This revision supersedes
|
||||||
|
the earlier all-domain override and campaign-only party-selection decisions.
|
||||||
|
|
||||||
|
### 2026-11-19 — Configuration ownership and native inspection clarified
|
||||||
|
|
||||||
|
Accepted ConfigKit's completed result as authoritative configuration, with
|
||||||
|
Narratio's schema, defaults, validation, and genuine resolution rules supplied
|
||||||
|
through ConfigKit's supported lifecycle. Narratio consumes the handoff without
|
||||||
|
mutation and produces separate domain catalogs, plans, and execution objects.
|
||||||
|
CommandKit's `ckconfig` integration neutrally exposes the native ConfigKit
|
||||||
|
features; Narratio does not reinterpret or improve their inspection semantics.
|
||||||
|
|
||||||
|
Superseded the requirement that app show/diff contain expanded artifacts and
|
||||||
|
generated publish rules. Standard inspection uses native results and adapters;
|
||||||
|
domain catalogs and planning commands expose the work derived from those
|
||||||
|
results. Remove post-load configuration mutation and separate inspection
|
||||||
|
snapshots rather than reconcile them with retained authoring evidence. Native
|
||||||
|
path and override semantics remain upstream contracts, not a Narratio design
|
||||||
|
problem.
|
||||||
|
|
||||||
|
The user identified the configuration/inspection split as a boundary violation.
|
||||||
|
The agreed correction is to restore ownership, not add machinery to make
|
||||||
|
different representations appear consistent. A potential ADR recording this
|
||||||
|
boundary is the next discussion topic.
|
||||||
|
|
||||||
|
### Continuing the discussion
|
||||||
|
|
||||||
|
For each topic, record the question, the agreed outcome, its rationale, and any
|
||||||
|
remaining dependency or follow-up. Date decisions and update the corresponding
|
||||||
|
open topic so settled issues are not repeatedly reopened. Distinguish proposals
|
||||||
|
from accepted decisions.
|
||||||
|
|
||||||
|
Once the relevant decisions are settled, consolidate the target behavior, scope,
|
||||||
|
compatibility impact, and acceptance criteria into the feature roadmap. Keep
|
||||||
|
implementation sequencing for the subsequent plan.
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
---
|
|
||||||
title: Select a Notarius configuration profile through Narratio
|
|
||||||
status: proposed
|
|
||||||
consumer: rakestraw.dnd Ansible collection and its pipeline role
|
|
||||||
|
|
||||||
use_case: >-
|
|
||||||
The Ansible pipeline role deploys Narratio and Notarius as independently
|
|
||||||
configured applications. Operators select Narratio's testing profile to
|
|
||||||
develop prompts and other pipeline assets with inexpensive models while
|
|
||||||
retaining production settings in the base configuration. That selection
|
|
||||||
currently cannot select a Notarius configuration profile, leaving extraction
|
|
||||||
on its production settings.
|
|
||||||
|
|
||||||
desired_outcome: >-
|
|
||||||
Narratio's testing overlay can explicitly select Notarius's testing overlay.
|
|
||||||
Notarius owns the resulting model choices and any other testing-specific
|
|
||||||
settings. The operator selects testing once when invoking Narratio, without
|
|
||||||
editing production files or separately invoking Notarius.
|
|
||||||
|
|
||||||
rationale: >-
|
|
||||||
Both applications already use ConfigKit configuration overlays. Selecting
|
|
||||||
the downstream overlay preserves each application's configuration ownership
|
|
||||||
and supports future Notarius testing adjustments without adding a Narratio
|
|
||||||
configuration field for every downstream setting. This is explicit profile
|
|
||||||
composition, not a requirement for arbitrary recursive orchestration.
|
|
||||||
|
|
||||||
requested_interface:
|
|
||||||
field: pipeline.notarius.config_profile
|
|
||||||
value: Optional Notarius ConfigKit configuration profile name
|
|
||||||
supplied: >-
|
|
||||||
Invoke Notarius with --config-profile and the selected name when extraction
|
|
||||||
executes. The setting is available in Narratio's base configuration and
|
|
||||||
its ordinary configuration overlays.
|
|
||||||
omitted_or_null: >-
|
|
||||||
Do not supply a profile-selection flag. Preserve existing Notarius
|
|
||||||
configuration selection behavior.
|
|
||||||
downstream_semantics: >-
|
|
||||||
Retain Notarius's existing selector semantics, including the default
|
|
||||||
selector for its base configuration. Notarius resolves profiles relative
|
|
||||||
to its own configuration root, not Narratio's root.
|
|
||||||
explicit_selection: >-
|
|
||||||
Do not automatically forward Narratio's profile name. The selected
|
|
||||||
Notarius profile may have the same name or a different name.
|
|
||||||
distinction: >-
|
|
||||||
This selects a ConfigKit configuration overlay through --config-profile,
|
|
||||||
not a PromptKit LLM profile through --llm-profile. The Notarius overlay
|
|
||||||
can itself select the desired LLM profiles using native Notarius settings.
|
|
||||||
|
|
||||||
illustrative_consumer_configuration:
|
|
||||||
note: >-
|
|
||||||
These are separate files managed by the Ansible suite, not a proposed
|
|
||||||
combined configuration document. The Notarius pipeline and LLM profile
|
|
||||||
names are illustrative; the referenced LLM profile must be available to
|
|
||||||
Notarius.
|
|
||||||
narratio_profiles_testing_yml: |
|
|
||||||
notarius:
|
|
||||||
config_profile: testing
|
|
||||||
notarius_profiles_testing_yml: |
|
|
||||||
pipelines:
|
|
||||||
dnd-session:
|
|
||||||
llm_profile: gemini-flash-latest
|
|
||||||
operator_workflow: >-
|
|
||||||
Select --profile testing on the ordinary Narratio invocation. Narratio
|
|
||||||
selects Notarius's testing configuration overlay when it runs extraction;
|
|
||||||
other Narratio testing overrides continue to apply normally.
|
|
||||||
|
|
||||||
observable_behavior:
|
|
||||||
- >-
|
|
||||||
Notarius owns overlay discovery, composition, validation, and the effective
|
|
||||||
downstream settings. A missing or invalid selected overlay must not silently
|
|
||||||
fall back to production or be reported as successful extraction.
|
|
||||||
- >-
|
|
||||||
Changing the selected Notarius configuration profile must not silently
|
|
||||||
reuse Narratio's completed extraction from the previous selection.
|
|
||||||
Existing downstream invalidation behavior applies when extraction changes.
|
|
||||||
- >-
|
|
||||||
Editing Notarius overlay contents behind an unchanged selector retains
|
|
||||||
the existing operator responsibility to force extraction when needed.
|
|
||||||
This request does not require inspecting or tracking private Notarius files.
|
|
||||||
- >-
|
|
||||||
Existing credential forwarding remains independently configurable through
|
|
||||||
notarius.llm_api_key, including in the Narratio testing overlay when the
|
|
||||||
selected Notarius settings require a different credential reference.
|
|
||||||
|
|
||||||
consumer_follow_up: >-
|
|
||||||
After Narratio releases this interface, the standalone Narratio Ansible role
|
|
||||||
can expose an optional variable and omit the field when unset. The suite role
|
|
||||||
can deploy Notarius's testing overlay and select it from Narratio's testing
|
|
||||||
overlay, then distribute the changes through the collection. These consumer
|
|
||||||
updates are separate from this upstream feature request.
|
|
||||||
|
|
||||||
scope_boundaries:
|
|
||||||
- No Notarius change is currently required; v0.7.0 supports --config-profile.
|
|
||||||
- No separate Narratio-side Notarius LLM-profile selector is requested.
|
|
||||||
- No automatic profile-name propagation or downstream configuration rewriting.
|
|
||||||
- No new credential discovery, copying, or provider-name remapping.
|
|
||||||
- This request specifies consumer behavior, not internal Narratio code changes.
|
|
||||||
|
|
||||||
references:
|
|
||||||
narratio_configuration: ../config.md
|
|
||||||
narratio_notarius_integration: ../integrations/notarius.md
|
|
||||||
notarius_cli: https://gitea.maximumdirect.net/eric/notarius/src/tag/v0.7.0/docs/cli.md
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
# Bugfix Request: Preserve Publish Destination Derivation with Explicit Rules
|
|
||||||
|
|
||||||
Status: Implemented; release target v2.1.1
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
Narratio should successfully derive a publish destination when a valid
|
|
||||||
`publish.outputs` rule omits `dest`, regardless of whether that rule explicitly
|
|
||||||
sets `required`. Narratio v2.1.0 currently rejects this valid configuration in
|
|
||||||
some cases with a ConfigKit `resolve.unrecorded_change` diagnostic.
|
|
||||||
|
|
||||||
This is a configuration-resolution bookkeeping defect, not a YAML formatting
|
|
||||||
restriction. The fix should preserve the existing public configuration
|
|
||||||
contract: operators may omit a derivable destination and may independently set
|
|
||||||
`required` to either `true` or `false`.
|
|
||||||
|
|
||||||
## Observed Behavior
|
|
||||||
|
|
||||||
A pipeline containing a rule equivalent to the following fails during native
|
|
||||||
configuration loading:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
publish:
|
|
||||||
outputs: [{"source": "narratio.transcript.final", "required": true}]
|
|
||||||
```
|
|
||||||
|
|
||||||
Narratio reports:
|
|
||||||
|
|
||||||
```text
|
|
||||||
error [resolve.unrecorded_change] /publish/outputs: application resolution changed a value without a covering record
|
|
||||||
```
|
|
||||||
|
|
||||||
The same failure is possible with ordinary block-style YAML when `required` is
|
|
||||||
explicit and `dest` is omitted. Flow-style YAML is valid input and is not the
|
|
||||||
cause of the defect.
|
|
||||||
|
|
||||||
The existing destination-derivation tests do not expose this case because
|
|
||||||
their rules also omit `required`. Narratio then supplies the default value for
|
|
||||||
`required` and records a change covering the complete `publish.outputs`
|
|
||||||
sequence. That broader record happens to cover the destination mutation as
|
|
||||||
well, masking the missing resolution record that occurs when `required` is
|
|
||||||
already explicit.
|
|
||||||
|
|
||||||
## Expected Contract
|
|
||||||
|
|
||||||
The current configuration contract remains unchanged:
|
|
||||||
|
|
||||||
- `publish.outputs[].source` is required;
|
|
||||||
- `publish.outputs[].dest` may be omitted when Narratio can derive it from the
|
|
||||||
selected built-in or configured artifact source;
|
|
||||||
- `publish.outputs[].required` defaults to `true`, but an operator may set it
|
|
||||||
explicitly to either `true` or `false`; and
|
|
||||||
- equivalent valid YAML representations have equivalent configuration
|
|
||||||
semantics.
|
|
||||||
|
|
||||||
For example, both rules below should load and validate, retain their explicit
|
|
||||||
requiredness, and receive the canonical derived destination:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
publish:
|
|
||||||
outputs:
|
|
||||||
- source: narratio.transcript.final
|
|
||||||
required: true
|
|
||||||
- source: narratio.transcript.final_markdown
|
|
||||||
required: false
|
|
||||||
```
|
|
||||||
|
|
||||||
## Root Cause
|
|
||||||
|
|
||||||
ConfigKit intentionally treats sequences as atomic when comparing values
|
|
||||||
before and after application resolution. Changing a field within one
|
|
||||||
`publish.outputs` entry is therefore observed as a change to the
|
|
||||||
`/publish/outputs` sequence.
|
|
||||||
|
|
||||||
Narratio currently derives each missing destination by recording a
|
|
||||||
normalization at the individual `publish.outputs[index].dest` path. That child
|
|
||||||
record does not cover the atomic parent-sequence change. A separate
|
|
||||||
container-level record is currently created only when Narratio also defaults
|
|
||||||
an omitted `required` value, so configurations with explicit `required` values
|
|
||||||
lose that incidental coverage.
|
|
||||||
|
|
||||||
## Recommended Fix
|
|
||||||
|
|
||||||
Make Narratio's publish-output resolution bookkeeping conform to ConfigKit's
|
|
||||||
atomic-sequence contract. Whenever resolution derives one or more destinations
|
|
||||||
inside `publish.outputs`, the recorded resolution changes must cover the
|
|
||||||
`/publish/outputs` container. Destination derivation must not depend on an
|
|
||||||
unrelated `required` default being applied in the same list.
|
|
||||||
|
|
||||||
The implementation may retain more specific provenance where useful, but it
|
|
||||||
must provide valid container-level coverage for the sequence mutation. Do not
|
|
||||||
change ConfigKit's sequence comparison semantics merely to accommodate this
|
|
||||||
call site.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
- Correct destination derivation for publish rules that explicitly set
|
|
||||||
`required` and omit a derivable `dest`.
|
|
||||||
- Preserve explicit `required: true` and `required: false` values.
|
|
||||||
- Preserve canonical destination derivation for built-in transcript sources
|
|
||||||
and configured artifact sources.
|
|
||||||
- Add focused regression coverage through Narratio's real configuration load
|
|
||||||
and validation boundary.
|
|
||||||
- Prepare a backward-compatible patch release after the fix passes the normal
|
|
||||||
repository validation.
|
|
||||||
|
|
||||||
## Non-goals
|
|
||||||
|
|
||||||
- Changing the `publish.outputs` schema, defaults, source vocabulary, or
|
|
||||||
destination derivation rules.
|
|
||||||
- Requiring operators or configuration generators to supply `dest` when it is
|
|
||||||
derivable.
|
|
||||||
- Requiring operators to omit explicit `required: true` values.
|
|
||||||
- Treating flow-style YAML or JSON-compatible YAML values as unsupported.
|
|
||||||
- Changing ConfigKit's documented atomic treatment of sequences.
|
|
||||||
- Adding storage, publication, or network integration behavior.
|
|
||||||
|
|
||||||
## Regression Coverage
|
|
||||||
|
|
||||||
Add one focused package-level behavioral test that loads and validates a
|
|
||||||
pipeline with omitted destinations and explicit requiredness. A representative
|
|
||||||
list should include both `required: true` and `required: false`, then assert
|
|
||||||
that:
|
|
||||||
|
|
||||||
- loading and validation succeed;
|
|
||||||
- each destination is derived from its source; and
|
|
||||||
- each explicit `required` value is preserved.
|
|
||||||
|
|
||||||
Using the compact flow-style representation that exposed the integration
|
|
||||||
failure is reasonable, while the existing block-style cases continue to cover
|
|
||||||
omitted `required`. The test should exercise the public configuration behavior,
|
|
||||||
not ConfigKit call choreography or Narratio's private recording mechanism.
|
|
||||||
|
|
||||||
No network service, object store, credential, or test double is required.
|
|
||||||
|
|
||||||
## Target End State
|
|
||||||
|
|
||||||
All valid publish rules with derivable sources behave consistently across
|
|
||||||
these cases:
|
|
||||||
|
|
||||||
| `dest` | `required` | Result |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| omitted | omitted | destination derived; required defaults to `true` |
|
|
||||||
| omitted | `true` | destination derived; explicit `true` retained |
|
|
||||||
| omitted | `false` | destination derived; explicit `false` retained |
|
|
||||||
| explicit | either value | explicit destination and requiredness retained |
|
|
||||||
|
|
||||||
`narratio config validate`, `narratio config show`, and ordinary pipeline
|
|
||||||
loading accept the corrected cases without an unrecorded-change diagnostic.
|
|
||||||
No operator configuration migration or workaround is required.
|
|
||||||
|
|
||||||
## Release
|
|
||||||
|
|
||||||
This is a backward-compatible correction to documented configuration behavior
|
|
||||||
and should be released as Narratio `v2.1.1`. The release note should identify
|
|
||||||
the corrected explicit-required/derived-destination interaction and state that
|
|
||||||
no special upgrade action is required.
|
|
||||||
|
|
||||||
## Acceptance Criteria
|
|
||||||
|
|
||||||
- The focused regression test fails against v2.1.0 behavior and passes after
|
|
||||||
the fix.
|
|
||||||
- Publish rules with explicit `required: true` or `required: false` and omitted
|
|
||||||
derivable destinations load and validate successfully.
|
|
||||||
- Derived destinations and explicit requiredness appear correctly in the safe
|
|
||||||
effective configuration.
|
|
||||||
- Existing destination derivation, publish validation, imports, profiles, and
|
|
||||||
configuration inspection tests remain green.
|
|
||||||
- The complete repository validation and release-candidate checks pass.
|
|
||||||
- The correction is published as the immutable `v2.1.1` tag with the required
|
|
||||||
release note.
|
|
||||||
@@ -1,482 +0,0 @@
|
|||||||
# Implementation Plan: Audita v2 and Shared Provider Credentials
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
## Scope and working instructions
|
|
||||||
|
|
||||||
Implement [the Audita roadmap](audita.md). The baseline is Narratio commit
|
|
||||||
`70f1dbf` (v2.2.1), with ConfigKit v0.4.0 and Audita v2.0.0 as the target
|
|
||||||
upstream contracts. This replaces the completed checkpoint-refactoring plan,
|
|
||||||
which remains in Git history.
|
|
||||||
|
|
||||||
Complete Stage 1 through Stage 8 in order, one bounded implementation prompt per
|
|
||||||
stage for gpt-5.6-terra. Record completion and actual verification results under
|
|
||||||
each stage. These instructions apply to the implementation sprint; the planning
|
|
||||||
pass changes documentation only. Intermediate stages are not release candidates.
|
|
||||||
Do not add compatibility code to make intermediate states look like a supported
|
|
||||||
release.
|
|
||||||
|
|
||||||
Before each stage, read `AGENTS.md`, `docs/development.md`, and all policies
|
|
||||||
under `docs/policy/`: agents, architecture, documentation, testing, and release.
|
|
||||||
Read this plan's selected design and that stage's preparation. Use Go 1.26 and graph-first code
|
|
||||||
discovery; inspect current files when graph results are incomplete. Preserve
|
|
||||||
unrelated changes. Test at behavioral owners rather than replicating every case
|
|
||||||
across configuration, adapter, stage, and command tests.
|
|
||||||
|
|
||||||
The user approved a clean cutover: no Audita v1 runner, deprecated aliases,
|
|
||||||
compatibility shims, generated configuration conversion, or silently ignored
|
|
||||||
old settings. Do not broaden that decision into a purge of unrelated legacy
|
|
||||||
code or historical session data.
|
|
||||||
|
|
||||||
## Selected design
|
|
||||||
|
|
||||||
### ConfigKit and Narratio overlay terminology
|
|
||||||
|
|
||||||
Upgrade ConfigKit from v0.3.1 to v0.4.0 before adapter work. Rename its
|
|
||||||
`Options.Profile`, `LayerProfile`, and any `CodeProfile*` uses to their overlay
|
|
||||||
equivalents. Selected pipeline files move from `profiles/<name>.yml` to
|
|
||||||
`overlays/<name>.yml`; no fallback directory or alias is permitted.
|
|
||||||
|
|
||||||
Rename Narratio's pipeline-selection flag to `--overlay` everywhere it is
|
|
||||||
accepted, including convenience commands and configuration inspection. Rename
|
|
||||||
application-owned selection types/helpers, help, errors, and current inspection
|
|
||||||
labels consistently. `config diff` still takes two positional selections,
|
|
||||||
now described as overlays. Preserve omission, explicit empty, and `default`
|
|
||||||
as base selection; do not add a persistent default selector or new precedence.
|
|
||||||
|
|
||||||
Rename newly written informational provenance to overlay terminology, including
|
|
||||||
`selected_overlay` in manifest configuration provenance. Do not add a dual-field
|
|
||||||
reader, automatically rewrite historical manifests, or introduce a manifest-version
|
|
||||||
rejection solely for this informational rename. Existing strict typed decoding
|
|
||||||
rejects retired provenance fields. Document backed-up operator migration of
|
|
||||||
that informational member without changing execution/checkpoint state; it does
|
|
||||||
not become resume authority. Preserve
|
|
||||||
semantic fingerprints and effective-value digest rules when values are unchanged.
|
|
||||||
|
|
||||||
Only Narratio pipeline configuration selection is renamed. Keep model/profile
|
|
||||||
fields such as Scriptorium `profile_id`, Audita `proposal_profile` and
|
|
||||||
`validation_profile`, and Notarius `config_profile` unchanged. Explicit imports
|
|
||||||
from directories named `profiles` remain legal; only selected pipeline overlay
|
|
||||||
discovery changes. Do not globally replace the word “profile.”
|
|
||||||
|
|
||||||
### Configuration and credentials
|
|
||||||
|
|
||||||
- Both `pipeline.audita.credentials` and `pipeline.notarius.credentials` are
|
|
||||||
lists of ConfigKit secret references. Use `[]configkit.Secret`; each element
|
|
||||||
is an actual reference rather than a nullable pointer. Existing ConfigKit
|
|
||||||
validation owns name/value resolution. Omitted, null, or empty lists mean no
|
|
||||||
additional credential forwarding.
|
|
||||||
- Define each key once through existing environment/secrets-directory bootstrap.
|
|
||||||
Forward it under its original name to each adapter whose list includes it.
|
|
||||||
No alias mappings, provider registry, downstream config inspection, extra
|
|
||||||
bootstrap, or inheritance of the entire environment.
|
|
||||||
- Repeated names need no new rejection rule: forwarding the same captured
|
|
||||||
reference once suffices. Arbitrary valid variable names remain supported;
|
|
||||||
provider names in the roadmap are examples, not an allowlist.
|
|
||||||
- Add a narrow shared helper in `internal/adapters/subprocess` converting resolved
|
|
||||||
references to `EnvOverrides` and `SensitiveEnvNames`. It checks the existing
|
|
||||||
resolved/nonempty requirement for direct adapter callers but never resolves
|
|
||||||
secrets or rereads environment values. Errors expose no values. Both adapters
|
|
||||||
use it; the ConfigKit upgrade is owned by Stage 1, not this helper. No new
|
|
||||||
credential service is needed.
|
|
||||||
- Configuration projections and diagnostic metadata contain reference names
|
|
||||||
only. Register all forwarded names for existing captured-stream redaction.
|
|
||||||
Downstream tools remain responsible for files they write themselves.
|
|
||||||
- Remove both singular `llm_api_key` fields. For Audita also remove `base_url`,
|
|
||||||
`model`, `validation_model`, `total_llm_concurrency`,
|
|
||||||
`proposal_llm_concurrency`, `validation_llm_concurrency`,
|
|
||||||
`work_dir_retention`, and `report`, including defaults and projections.
|
|
||||||
- Retain Audita `binary`, `timeout`, `config_path`, `transcript_description`,
|
|
||||||
`output_schema`, and `modules`. Add optional string selectors `overlay`,
|
|
||||||
`proposal_profile`, and `validation_profile`: empty/unset means no CLI
|
|
||||||
override. Audita owns downstream file/profile validation and native config
|
|
||||||
discovery. Narratio overlay names are not implicitly Audita overlay names.
|
|
||||||
- Preserve nil versus non-nil empty `modules` through loading, projection,
|
|
||||||
cloning, composition, adapter defaults, and request overrides. Nil omits the
|
|
||||||
flag; empty passes `--modules` with an empty argument; nonempty joins in order
|
|
||||||
with repetitions intact. A nil request override uses the configured selection.
|
|
||||||
Avoid clones that collapse empty slices to nil. YAML null follows unset
|
|
||||||
behavior. Other adapters' module semantics do not change.
|
|
||||||
|
|
||||||
### Invocation, reports, and failure
|
|
||||||
|
|
||||||
Use `process INPUT --glossary PATH --output PATH` plus selected surviving
|
|
||||||
overrides. Production passes no reporting or debug switches, including
|
|
||||||
`--debug`, `--reporting=false`, `--report-dir`, or `--work-dir`.
|
|
||||||
Remove required `WorkDir` and legacy `ReportPath` request/result plumbing.
|
|
||||||
Document production external-config defaults without forcibly overriding or
|
|
||||||
rejecting deliberate external reporting/debug choices.
|
|
||||||
|
|
||||||
Replace Audita's long positional config-values constructor with typed runner
|
|
||||||
configuration. Keep timeout parsing in composition and subprocess cancellation
|
|
||||||
through the existing runner. No version probe or automatic config-validation
|
|
||||||
subprocess is required.
|
|
||||||
|
|
||||||
The corrected transcript remains the only canonical polish output, with existing
|
|
||||||
identity, path, validation, and bounded file handling. Discover exactly
|
|
||||||
`errors.yml`, `recoveries.yml`, and `report.md` beside the requested output.
|
|
||||||
Represent available paths in a small typed report bundle in `PolishResult`.
|
|
||||||
Fixed names belong to the adapter; do not parse stderr or recursively scan.
|
|
||||||
|
|
||||||
Reports are diagnostics, not a new correctness gate:
|
|
||||||
|
|
||||||
- Bound reads of present reports using the existing named 16 MiB report limit;
|
|
||||||
retain confined regular-file handling and errors identifying Audita, the file,
|
|
||||||
and limit. No new smaller limits or report schema/status/count validation is
|
|
||||||
necessary when Narratio only preserves bytes; Markdown needs no parser.
|
|
||||||
- Missing files are not independently fatal: external configuration can disable
|
|
||||||
reports and early failures may produce none. Default-reporting success tests
|
|
||||||
must nevertheless demonstrate capture of all three files.
|
|
||||||
- On process failure, preserve available diagnostics and the original error;
|
|
||||||
report-inspection errors must not hide it. Never promote an output merely
|
|
||||||
because it exists following a nonzero exit.
|
|
||||||
- Exit zero with a valid transcript may include recoverable errors or no model
|
|
||||||
corrections. Accept it without a fail-on-recovery or minimum-correction rule.
|
|
||||||
|
|
||||||
Keep reports next to the run-local transcript, not in a second canonical
|
|
||||||
destination. Register present report paths in the existing `StageResult.Logs`
|
|
||||||
diagnostic collection alongside stdout/stderr, with safe bundle-path metadata.
|
|
||||||
Reuse current manifest-driven diagnostic publication rather than adding a
|
|
||||||
manifest schema or new publish source IDs. Physical placement does not define
|
|
||||||
canonical artifact identity. Existing diagnostic retention/cleanup rules apply.
|
|
||||||
|
|
||||||
On failure, retain run-local files and expose the output/report directory in
|
|
||||||
contextual errors. Do not add runner-wide failed-result persistence merely to
|
|
||||||
register those files. Do not fabricate legacy JSON reports or delete historical
|
|
||||||
reports. Normal successful stage-record replacement removes obsolete current
|
|
||||||
output references.
|
|
||||||
|
|
||||||
Generated invocation YAML becomes `audita.generated.v2`, recording actual
|
|
||||||
arguments, selections, paths, and credential names, never values. This remains
|
|
||||||
a diagnostic invocation record, not an Audita configuration file.
|
|
||||||
|
|
||||||
### Resume boundary
|
|
||||||
|
|
||||||
Bump only polish semantic-config version from 1 to 2. Record config path,
|
|
||||||
overlay/proposal/validation selectors, ordered modules with presence preserved,
|
|
||||||
transcript description, output schema, and existing output identity. Remove old
|
|
||||||
endpoint/model fields. Existing runner comparison reconsiders obsolete evidence
|
|
||||||
when polish is selected; do not synthesize equivalent fingerprints or expand
|
|
||||||
normal dependency/selection invalidation.
|
|
||||||
|
|
||||||
Credentials, binary path, timeout, and diagnostics are not semantic keys. Do not
|
|
||||||
hash downstream config/profile contents; operators force polish after edits
|
|
||||||
behind unchanged selections. Notarius credential migration does not change
|
|
||||||
extraction fingerprints, references, force, resume, or chunk-cache behavior.
|
|
||||||
|
|
||||||
## Stage 1: Adopt ConfigKit v0.4.0 and pipeline overlays
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/config ./internal/app ./internal/manifest`,
|
|
||||||
`go test ./...`, `go test ./internal/doccheck`,
|
|
||||||
`go test ./internal/config -run '^TestExamplesLoadAndValidate$'`, and
|
|
||||||
`git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: ConfigKit v0.4.0 release notes and selected-overlay migration guide
|
|
||||||
in `../ConfigKit/docs/`; Narratio `internal/config/pipeline_configkit.go`,
|
|
||||||
`artifact_catalog.go`, `load.go`, `effective_digest.go`; CLI flag parsing and
|
|
||||||
config commands in `internal/app/`; configuration provenance in
|
|
||||||
`internal/manifest/manifest.go`; current config/CLI docs and pipeline examples.
|
|
||||||
|
|
||||||
1. Update `go.mod`/`go.sum` to ConfigKit v0.4.0 using normal module tooling;
|
|
||||||
do not leave a local replacement or change unrelated dependencies.
|
|
||||||
Replace removed ConfigKit APIs in loading, ownership, and artifact catalog
|
|
||||||
inspection. Account for source layer `overlay` and diagnostic prefix
|
|
||||||
`overlay.*` wherever they are consumed or asserted.
|
|
||||||
2. Rename Narratio's pipeline selector to `--overlay` across all commands and
|
|
||||||
aliases, load options, pair loading, inspection, provenance, and tests.
|
|
||||||
Preserve explicit-presence handling through convenience commands and existing
|
|
||||||
base/default selection. Remove `--profile` rather than retaining an alias.
|
|
||||||
Apply the selected design's informational manifest-provenance treatment.
|
|
||||||
3. Move maintained selected pipeline files and generated fixture paths to
|
|
||||||
`overlays/`. Update current canonical documentation, policy terminology,
|
|
||||||
examples, and user-visible migration guidance with the directory/flag break.
|
|
||||||
Do not rewrite historical release notes, rename downstream model profiles,
|
|
||||||
or prohibit ordinary explicit imports from a directory named `profiles`.
|
|
||||||
4. Adapt existing config/app tests to prove base and named-overlay selection,
|
|
||||||
imported defaults plus overrides, secret replacement/removal, source attribution
|
|
||||||
through character-family expansion, config diff, and convenient-command
|
|
||||||
forwarding. Add focused checks that the retired flag is rejected and the old
|
|
||||||
directory is not a discovery fallback. Do not freeze incidental error wording.
|
|
||||||
5. Verify unchanged effective values retain digest and stage-reuse behavior;
|
|
||||||
only diagnostic source labels/paths and selected provenance terminology change.
|
|
||||||
Test current provenance round trips and strict rejection of unknown/retired
|
|
||||||
provenance fields. Document deliberate operator migration; do not add a
|
|
||||||
compatibility decoder, semantic invalidation rule, or schema-version gate.
|
|
||||||
6. Run focused and full tests before proceeding so failures from the dependency
|
|
||||||
and terminology change are separated from adapter migrations. No Audita or
|
|
||||||
Notarius credential/CLI behavior changes in this stage.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/config ./internal/app ./internal/manifest`,
|
|
||||||
`go test ./...`, `go test ./internal/doccheck`,
|
|
||||||
`go test ./internal/config -run '^TestExamplesLoadAndValidate$'`, and
|
|
||||||
`git diff --check`.
|
|
||||||
|
|
||||||
Done when Narratio uses ConfigKit v0.4.0, exposes pipeline overlays consistently,
|
|
||||||
has no old selector/directory fallback, and preserves configuration semantics and
|
|
||||||
downstream model-profile concepts.
|
|
||||||
|
|
||||||
## Stage 2: Add shared resolved-credential forwarding
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/adapters/subprocess`,
|
|
||||||
`go test -race ./internal/adapters/subprocess`, and `git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: `internal/adapters/subprocess/run.go`, its environment/redaction
|
|
||||||
helpers and tests; `internal/adapters/notarius/subprocess.go`;
|
|
||||||
`internal/config/credential_projection.go`; the pinned ConfigKit secret API.
|
|
||||||
|
|
||||||
1. Add the narrow helper described above. Return an independent environment map
|
|
||||||
and selected sensitive names. No logging/serialization of values and no
|
|
||||||
changes to minimal child environment inheritance.
|
|
||||||
2. Test multiple custom names, empty lists, repeated names, unresolved references,
|
|
||||||
and captured values after the parent environment changes. Reuse existing
|
|
||||||
split/overlapping-stream redaction coverage rather than repeating its matrix.
|
|
||||||
3. Leave production callers unchanged until their migrations.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/adapters/subprocess` and
|
|
||||||
`go test -race ./internal/adapters/subprocess`.
|
|
||||||
|
|
||||||
Done when both adapters can reuse one small conversion mechanism without adding
|
|
||||||
a resolver, provider policy, or ambient-secret inheritance.
|
|
||||||
|
|
||||||
## Stage 3: Migrate Notarius to credential lists
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/config ./internal/adapters/notarius ./internal/stage ./internal/app`,
|
|
||||||
`go test -race ./internal/adapters/notarius`, and `git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: `internal/config/config.go`, `credential_projection.go`, loading/
|
|
||||||
inspection tests; `internal/adapters/notarius/runner.go`, `subprocess.go`;
|
|
||||||
`internal/stage/extract.go` and its request construction;
|
|
||||||
`docs/integrations/notarius.md` and secret handling in `docs/config.md`.
|
|
||||||
|
|
||||||
1. Replace the singular field with the typed list across configuration,
|
|
||||||
projection, request types, stage wiring, and adapter execution. Use Stage 2's
|
|
||||||
helper and register all selected names for redaction.
|
|
||||||
2. Update name-only metadata and config-show/diff/effective projections. Test
|
|
||||||
real ConfigKit loading, overlay list replacement, and empty-list clearing.
|
|
||||||
Preserve bootstrap precedence and existing load-time reference resolution,
|
|
||||||
including references outside the selected stage range.
|
|
||||||
3. Migrate maintained examples, fixtures, and current Notarius configuration/
|
|
||||||
integration documentation for this field. Ordinary strict decoding rejects
|
|
||||||
the old field; do not add a compatibility parser.
|
|
||||||
4. Cover multi-key forwarding, unselected-key exclusion, empty selection,
|
|
||||||
captured-value behavior, and custom-name redaction on success/failure.
|
|
||||||
Keep extraction cache/reference/output tests as regression protection,
|
|
||||||
not occasions to redesign extraction.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/config ./internal/adapters/notarius ./internal/stage ./internal/app`
|
|
||||||
and `go test -race ./internal/adapters/notarius`.
|
|
||||||
|
|
||||||
Done when Notarius uses credential lists end to end and no active singular
|
|
||||||
credential path remains.
|
|
||||||
|
|
||||||
## Stage 4: Cut Audita configuration and adapter over to v2
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/config ./internal/adapters/audita ./internal/stage ./internal/app`,
|
|
||||||
`go test -race ./internal/adapters/audita`, `go test ./...`, and
|
|
||||||
`git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: Audita v2.0.0 `docs/migrations/v2.md`, `docs/cli.md`,
|
|
||||||
`docs/integrations/subprocess.md`, and `docs/integrations/output-files.md` in
|
|
||||||
`../audita/`; Narratio `internal/adapters/audita/`,
|
|
||||||
`internal/app/runner.go` (`buildDefaultAuditaRunner`), and config types,
|
|
||||||
defaults, validation, and credential projection.
|
|
||||||
|
|
||||||
1. Replace the Audita configuration surface as selected above, updating defaults,
|
|
||||||
validation, safe projection, examples, and config fixtures. Prove nil/empty
|
|
||||||
modules survive real configuration loading and overlay overrides.
|
|
||||||
2. Migrate runner construction, selectors, and credential forwarding. Remove
|
|
||||||
retired flags, fixed credential alias, required work-directory plumbing, and
|
|
||||||
old JSON-report validation. Add the typed report bundle.
|
|
||||||
3. Implement adjacent report discovery, bounded reads, failure results, and
|
|
||||||
generated invocation v2. Share metadata construction between success/failure
|
|
||||||
instead of maintaining duplicate field maps.
|
|
||||||
4. Rewrite the Audita subprocess fixture to model v2 argument acceptance and
|
|
||||||
output placement. Cover omitted/selected selectors, ordered/repeated/empty
|
|
||||||
modules, no report/debug switches, malformed/missing transcript, ordinary
|
|
||||||
reports, externally disabled reporting, recoverable-error success, and
|
|
||||||
nonzero exit after transcript creation. Cover multiple custom credential names
|
|
||||||
and redaction; preserve timeout/cancellation coverage at its existing owner.
|
|
||||||
5. Make mechanical polish and app-fixture adjustments needed to compile: remove
|
|
||||||
obsolete request/metadata fields and old report materialization. Stage 5 owns
|
|
||||||
complete diagnostic integration. Remove retired fingerprint members as needed
|
|
||||||
to compile; Stage 6 completes the replacement semantic contract. These are
|
|
||||||
bounded call-site changes, not permission to introduce transitional shims.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/config ./internal/adapters/audita ./internal/stage ./internal/app`
|
|
||||||
and `go test -race ./internal/adapters/audita`.
|
|
||||||
|
|
||||||
Done when configuration composes a v2-only adapter and subprocess tests prove its
|
|
||||||
credential/transcript/report boundary. Stages 5 and 6 complete diagnostic and
|
|
||||||
semantic integration; all stages are required before release.
|
|
||||||
|
|
||||||
## Stage 5: Integrate polish reports with diagnostic lifecycle
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/stage ./internal/app ./internal/manifest ./internal/artifacts`,
|
|
||||||
`go test -race ./internal/stage ./internal/app`, and `git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: `internal/stage/polish.go`, `polish_test.go`, `run_local.go`,
|
|
||||||
`stage.go`, `publish_sources.go`; result application in `internal/app/runner.go`;
|
|
||||||
publish/restore diagnostic tests; `docs/internal/stage-polish.md`.
|
|
||||||
|
|
||||||
1. Finish stage integration: materialize only the canonical polished transcript;
|
|
||||||
register available adjacent reports as diagnostics plus safe metadata and
|
|
||||||
existing logs/generated invocation references. Remove old `audita_report`
|
|
||||||
production and stale stage metadata.
|
|
||||||
2. Use existing authoritative-path checks for the requested transcript and fixed
|
|
||||||
adjacent report paths. Do not accept arbitrary fake-returned paths, scan
|
|
||||||
directories, or copy reports to a second destination. Preserve workspace
|
|
||||||
handling/modes.
|
|
||||||
3. On execution failure, preserve canonical transcript authority and run-local
|
|
||||||
diagnostics, with actionable directory/log context and original error identity.
|
|
||||||
Test failure after output creation.
|
|
||||||
4. Adapt the fake and app helper. With real manifest/store collaborators, prove
|
|
||||||
successful promotion, report references, absence of report canonical outputs,
|
|
||||||
and current-run diagnostic publication. Preserve restore's existing scope of
|
|
||||||
declared committed transcript/artifact objects: run-archive diagnostics do not
|
|
||||||
become automatically restored canonical objects. Test that report references
|
|
||||||
do not create new required canonical restore targets. Document remote diagnostic
|
|
||||||
inspection separately; no new diagnostic-restore feature is authorized.
|
|
||||||
5. Leave historical files untouched. Update tests expecting a second canonical
|
|
||||||
polish output without introducing a manifest-format migration.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/stage ./internal/app ./internal/manifest ./internal/artifacts`
|
|
||||||
and `go test -race ./internal/stage ./internal/app`.
|
|
||||||
|
|
||||||
Done when reports use existing diagnostic lifecycle and failed execution cannot
|
|
||||||
promote an incidental transcript.
|
|
||||||
|
|
||||||
## Stage 6: Complete semantic evidence and resume behavior
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/stage ./internal/app`,
|
|
||||||
`go test -race ./internal/stage ./internal/app`, and `git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: `internal/stage/semantic_contracts_refinement.go`, semantic
|
|
||||||
fingerprint tests, app runner semantic comparison tests, and extraction semantic
|
|
||||||
configuration tests (locate their current owners through graph discovery).
|
|
||||||
|
|
||||||
1. Implement polish evidence version 2 and the selected payload. Remove sorting;
|
|
||||||
preserve nil/empty distinction in payload encoding and copies.
|
|
||||||
2. Test changes from module order/repetition/presence and external selectors.
|
|
||||||
Credentials and execution-only settings do not change evidence. Avoid
|
|
||||||
assertions on incidental digest literals.
|
|
||||||
3. Exercise old-version evidence through runner resume behavior: selected polish
|
|
||||||
is reconsidered and normal dependent invalidation applies. Downstream-only
|
|
||||||
bounded execution does not unexpectedly invoke polish. Unchanged new evidence
|
|
||||||
reuses valid completed output.
|
|
||||||
4. Confirm credential-list changes leave extraction semantic/cache behavior
|
|
||||||
unchanged. No downstream file-content scanning or eager fingerprint migration.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/stage ./internal/app` and
|
|
||||||
`go test -race ./internal/stage ./internal/app`.
|
|
||||||
|
|
||||||
Done when selections affect reuse accurately without blanket credential/config
|
|
||||||
invalidation or changes to unselected-stage execution.
|
|
||||||
|
|
||||||
## Stage 7: Complete operator migration documentation and examples
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: `go test ./internal/doccheck`,
|
|
||||||
`go test ./internal/config -run '^TestExamplesLoadAndValidate$'`, and
|
|
||||||
`git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: documentation policy; `docs/config.md`, `docs/operations.md`,
|
|
||||||
`docs/troubleshooting.md`, both integration guides,
|
|
||||||
`docs/internal/adapters.md`, `docs/internal/stage-polish.md`, and pipeline examples.
|
|
||||||
|
|
||||||
1. Complete current-behavior documentation as implementation lands. Configuration
|
|
||||||
owns fields/defaults; integrations own external contracts; operations owns
|
|
||||||
placement and migration; internal docs explain ownership and link onward.
|
|
||||||
2. Provide an old-to-new migration table: endpoints/capacity move to Audita
|
|
||||||
backends, models to profiles, role selection to selectors, and credentials to
|
|
||||||
provider-named lists. Remove report/retention settings. Explain Audita's
|
|
||||||
all-configured-backend credential resolution and Notarius's profile lookup.
|
|
||||||
3. Describe preparing and validating Audita v2 config offline with its documented
|
|
||||||
command before switching executables. Link upstream examples rather than
|
|
||||||
building a downstream configuration generator. Explain ordinary reports,
|
|
||||||
recoverable-error success, and force after edits behind unchanged selectors.
|
|
||||||
4. Production examples omit modules when upstream defaults are intended;
|
|
||||||
`modules: []` deliberately disables correction modules. Production external
|
|
||||||
Audita config keeps reports enabled/debug disabled, without Narratio flag
|
|
||||||
overrides. Testing-profile debug integration remains deferred.
|
|
||||||
5. Document the configuration-breaking clean cutover for release-version
|
|
||||||
consideration. Do not edit historical release records, tag a release, or
|
|
||||||
remove unrelated roadmaps.
|
|
||||||
|
|
||||||
Verify: `go test ./internal/doccheck`,
|
|
||||||
`go test ./internal/config -run '^TestExamplesLoadAndValidate$'`, and
|
|
||||||
`git diff --check`.
|
|
||||||
|
|
||||||
Done when operators can migrate using valid examples without obsolete fields,
|
|
||||||
implicit credential aliases, or retired CLI/report expectations.
|
|
||||||
|
|
||||||
## Stage 8: Verify assembled behavior and audit scope
|
|
||||||
|
|
||||||
Status: Complete (2026-09-25).
|
|
||||||
|
|
||||||
Verification: the offline app-level shared/Audita-only credential scenario
|
|
||||||
passed with config bootstrap, both subprocess fixtures, safe inspection/logging,
|
|
||||||
and ordinary polish reports. The tagged Audita v2.0.0 CLI validated its minimal
|
|
||||||
configuration and produced a transcript plus all three reports with an empty
|
|
||||||
module sequence and no provider request. Active-reference and scope audits found
|
|
||||||
no removed production fields or compatibility path; remaining old names occur in
|
|
||||||
migration guidance, explicit-rejection checks, or historical fixtures. `go test
|
|
||||||
./...`, `go test -race ./...`, `go vet ./...`, `go build ./...`, `go test
|
|
||||||
./internal/doccheck`, `go test ./internal/config -run
|
|
||||||
'^TestExamplesLoadAndValidate$'`, and `git diff --check` passed.
|
|
||||||
|
|
||||||
Preparation: cumulative diff, this plan, feature roadmap, app configuration/
|
|
||||||
subprocess integration tests, and all policies.
|
|
||||||
|
|
||||||
1. Adapt or add one representative offline app-level scenario showing one
|
|
||||||
provider-named secret source supplying both adapters and another key selected
|
|
||||||
only for Audita. Use real config/bootstrap/composition with subprocess fixtures.
|
|
||||||
Prove safe inspection/logging and successful polish reports. Leave exhaustive
|
|
||||||
flag/redaction cases at lower layers.
|
|
||||||
2. Where the tagged Audita checkout is available, smoke-test CLI acceptance and
|
|
||||||
ordinary transcript/reports offline with an explicit minimal v2 config,
|
|
||||||
unauthenticated backend/profile fixtures, and an empty module sequence.
|
|
||||||
No provider requests or production credentials. This is optional local evidence,
|
|
||||||
not a default test dependent on sibling checkouts or installed tools.
|
|
||||||
3. Audit active references to removed fields/flags/aliases; historical release
|
|
||||||
notes and completed roadmaps are not compatibility code. Review tests
|
|
||||||
collectively for duplication while retaining consequential failure coverage.
|
|
||||||
4. Confirm no provider-name restrictions, duplicate-name rejection, downstream
|
|
||||||
content hashing, fail-on-recovery rule, mandatory explicit config path, debug
|
|
||||||
requirement, live-service gate, pipeline-order change, or Notarius cache change
|
|
||||||
slipped in. Do not require missing reports when disabled externally. Surface
|
|
||||||
additional policy choices rather than encoding them silently in tests.
|
|
||||||
5. Run every gate below and record actual results. Mark complete only after all
|
|
||||||
stages and gates pass. No release, tag, push, or unrelated cleanup in this plan.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go test ./...
|
|
||||||
go test -race ./...
|
|
||||||
go vet ./...
|
|
||||||
go build ./...
|
|
||||||
go test ./internal/doccheck
|
|
||||||
go test ./internal/config -run '^TestExamplesLoadAndValidate$'
|
|
||||||
git diff --check
|
|
||||||
```
|
|
||||||
|
|
||||||
Done when the assembled v2 integration and shared credentials meet the roadmap,
|
|
||||||
verification passes, and no compatibility machinery remains within scope.
|
|
||||||
|
|
||||||
## Open Questions
|
|
||||||
|
|
||||||
None requiring a product decision before implementation. The user settled the
|
|
||||||
clean cutover and shared provider-named lists. Reports use existing diagnostics
|
|
||||||
without new content-based success criteria; debug-profile work remains deferred.
|
|
||||||
Release version selection belongs to the later release procedure.
|
|
||||||
@@ -1,151 +0,0 @@
|
|||||||
# Notarius Configuration Profile Selection
|
|
||||||
|
|
||||||
Status: Implemented.
|
|
||||||
|
|
||||||
## Goal and Authority
|
|
||||||
|
|
||||||
Implement the consumer behavior in the
|
|
||||||
[feature request](feature-request-notarius-config-profile.yml): let a Narratio
|
|
||||||
configuration overlay explicitly select a Notarius configuration overlay.
|
|
||||||
Operators can select testing once in Narratio while each application retains
|
|
||||||
ownership of its own model choices and other settings.
|
|
||||||
|
|
||||||
This roadmap describes the target state and required change areas, not an
|
|
||||||
implementation sequence; the [implementation plan](implementation.md) owns
|
|
||||||
the ordered work and implementation decisions. The feature request is the scope
|
|
||||||
authority; the mechanisms suggested below do not establish additional
|
|
||||||
user-facing contracts.
|
|
||||||
|
|
||||||
## Underlying Issue
|
|
||||||
|
|
||||||
Narratio can select its own testing profile, but extraction currently invokes
|
|
||||||
Notarius without a configuration-profile selector. Consequently, a Narratio
|
|
||||||
testing invocation cannot explicitly select the independently deployed Notarius
|
|
||||||
testing overlay through pipeline configuration.
|
|
||||||
|
|
||||||
Adding individual downstream model or tuning fields would duplicate Notarius's
|
|
||||||
configuration responsibilities. Passing its existing profile selector provides
|
|
||||||
the requested flexibility without that duplication.
|
|
||||||
|
|
||||||
## Targeted End State
|
|
||||||
|
|
||||||
### Explicit Configuration Composition
|
|
||||||
|
|
||||||
`pipeline.notarius.config_profile` is an optional Notarius configuration-profile
|
|
||||||
name, usable in Narratio's base configuration and ordinary overlays. For
|
|
||||||
example, Narratio's `profiles/testing.yml` may contain:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
notarius:
|
|
||||||
config_profile: testing
|
|
||||||
```
|
|
||||||
|
|
||||||
Selecting Narratio's `--profile testing` then selects that explicit downstream
|
|
||||||
profile whenever extraction executes. The two profile names need not match.
|
|
||||||
Narratio does not automatically forward its own profile name.
|
|
||||||
|
|
||||||
When supplied, the selection is passed through Notarius's `--config-profile`
|
|
||||||
argument. Omitted or null values add no profile-selection flag and preserve
|
|
||||||
existing downstream selection behavior. Notarius's selector semantics remain
|
|
||||||
authoritative, including empty and `default` selections for the composed base
|
|
||||||
configuration. Narratio does not introduce a stricter profile-name policy.
|
|
||||||
|
|
||||||
This field selects a ConfigKit configuration overlay, not a PromptKit profile
|
|
||||||
through `--llm-profile`. The Notarius overlay owns any resulting LLM-profile
|
|
||||||
selection. Notarius resolves overlays relative to its own configuration root;
|
|
||||||
Narratio neither resolves those files against its own root nor rewrites them.
|
|
||||||
|
|
||||||
### Execution, Reuse, and Failure
|
|
||||||
|
|
||||||
A changed downstream profile selection must not silently reuse Narratio's
|
|
||||||
completed extraction from the previous selection. Existing dependent-stage
|
|
||||||
invalidation applies when extraction changes; the feature does not change the
|
|
||||||
pipeline order or transcript-generation behavior.
|
|
||||||
|
|
||||||
Notarius continues to own downstream overlay discovery, composition, validation,
|
|
||||||
and cache compatibility. A missing or invalid selected overlay must fail
|
|
||||||
extraction through the existing subprocess error path, without silently falling
|
|
||||||
back to production or reporting successful extraction.
|
|
||||||
|
|
||||||
Existing resume and chunk-cache controls, including force precedence, remain
|
|
||||||
in place. Profile selection does not itself mean forced regeneration or cache
|
|
||||||
deletion. Narratio's decision to execute extraction and Notarius's decision to
|
|
||||||
reuse compatible work remain separate responsibilities.
|
|
||||||
|
|
||||||
Changes to private Notarius configuration behind an unchanged selector retain
|
|
||||||
the existing operator responsibility to force extraction when needed. There is
|
|
||||||
no new downstream file inspection or content-tracking requirement.
|
|
||||||
|
|
||||||
Credential forwarding remains independently configured through
|
|
||||||
`notarius.llm_api_key`. A Narratio testing overlay may select a different
|
|
||||||
credential reference alongside the downstream profile; no new credential
|
|
||||||
discovery or provider-name mapping is introduced.
|
|
||||||
|
|
||||||
## Required Change Areas
|
|
||||||
|
|
||||||
### Configuration and Inspection
|
|
||||||
|
|
||||||
Extend the typed Notarius configuration and its existing safe effective-YAML
|
|
||||||
projection to carry the optional field. Preserve the ordinary configuration
|
|
||||||
composition behavior for base values, overlay overrides, and null values.
|
|
||||||
Configuration inspection must reflect the selected field without exposing
|
|
||||||
credential values. No replacement configuration loader or downstream preflight
|
|
||||||
loader is needed.
|
|
||||||
|
|
||||||
### Stage and Adapter Boundary
|
|
||||||
|
|
||||||
Carry the selection from resolved configuration through the extraction request
|
|
||||||
to the subprocess adapter. Construct the optional CLI flag using the existing
|
|
||||||
argument-vector mechanism, alongside the current configuration path, references,
|
|
||||||
credential forwarding, and cache controls. Retain normal Notarius error handling.
|
|
||||||
|
|
||||||
### Extraction Reuse Evidence
|
|
||||||
|
|
||||||
Account for the downstream selection in the existing extraction reuse evidence.
|
|
||||||
The current semantic-configuration and invocation fingerprints are the relevant
|
|
||||||
change points. Keep their treatment of selection consistent so that a profile
|
|
||||||
change cannot bypass the required rerun and downstream invalidation.
|
|
||||||
|
|
||||||
This roadmap does not require a new manifest schema, separate profile-indexed
|
|
||||||
workspaces, historical per-profile result retention, or an upgrade-wide forced
|
|
||||||
rerun.
|
|
||||||
|
|
||||||
### Verification and Documentation
|
|
||||||
|
|
||||||
Use focused behavioral coverage for configuration composition and inspection,
|
|
||||||
explicit argument forwarding and omission, changed-selection reuse decisions,
|
|
||||||
and ordinary subprocess failure handling. Reuse existing test coverage where
|
|
||||||
it already protects unchanged credentials, force behavior, and invalidation;
|
|
||||||
do not duplicate Notarius's complete profile-validation or cache test suites.
|
|
||||||
|
|
||||||
When implemented, update the canonical
|
|
||||||
[configuration reference](../config.md),
|
|
||||||
[Notarius integration contract](../integrations/notarius.md),
|
|
||||||
[extract internals](../internal/stage-extract.md), and relevant maintained
|
|
||||||
examples. The development workflow in [Operations](../operations.md) should
|
|
||||||
explain explicit profile composition and the existing need to force extraction
|
|
||||||
after private downstream edits. Clarify that profile selection does not create
|
|
||||||
an isolated testing workspace or separate current extraction state.
|
|
||||||
|
|
||||||
## Compatibility and Scope Boundaries
|
|
||||||
|
|
||||||
Notarius v0.7.0 already documents `--config-profile`; no upstream change is
|
|
||||||
required. Document the capability needed when the option is used, without adding
|
|
||||||
an unconditional runtime version gate for existing unconfigured deployments.
|
|
||||||
|
|
||||||
This feature adds no Narratio CLI selector, automatic profile propagation,
|
|
||||||
Notarius LLM-profile selector, downstream configuration rewriting, new
|
|
||||||
credential mechanism, or generalized recursive orchestration. Existing output
|
|
||||||
and receipt contracts remain unchanged.
|
|
||||||
|
|
||||||
The consumer's Ansible role and suite updates are follow-up work outside this
|
|
||||||
repository. They can deploy downstream overlays and populate this field after
|
|
||||||
the interface is released.
|
|
||||||
|
|
||||||
## Scope Review
|
|
||||||
|
|
||||||
No stronger requirements or new invariants are proposed beyond the feature
|
|
||||||
request and existing repository contracts. In particular, minimizing one-time
|
|
||||||
upgrade invalidation and avoiding reruns between equivalent base selectors are
|
|
||||||
implementation considerations, not additional acceptance guarantees imposed
|
|
||||||
by this roadmap. No user decisions are currently required before planning.
|
|
||||||
@@ -1,227 +0,0 @@
|
|||||||
# Audita v2 and ConfigKit Migration Review Remediation
|
|
||||||
|
|
||||||
Status: Complete.
|
|
||||||
|
|
||||||
Reviewed `83eaa96` through `fae18bf` against the approved clean-cutover decisions,
|
|
||||||
[feature roadmap](audita.md), and [implementation plan](implementation.md).
|
|
||||||
Review date: 2026-09-25. No production changes were made. The previous completed
|
|
||||||
transcription review is retained below as historical context.
|
|
||||||
|
|
||||||
## 1. Preserve omitted modules in direct YAML serialization
|
|
||||||
|
|
||||||
Priority: P2. Status: Complete.
|
|
||||||
|
|
||||||
The safe YAML projection now omits nil modules while retaining explicit empty
|
|
||||||
and ordered/repeated selections. A round-trip regression failed before the fix
|
|
||||||
and passes afterward. Config package tests, including credential-safety coverage,
|
|
||||||
and its race tests pass.
|
|
||||||
|
|
||||||
Location: `internal/config/credential_projection.go:25` (`AuditaConfig.MarshalYAML`),
|
|
||||||
especially the plain slice field at line 30 and assignment at line 40.
|
|
||||||
|
|
||||||
The direct safe YAML projection passes a nil module slice to yaml.v3, which
|
|
||||||
serializes it as `modules: []`. Loading that output produces a non-nil empty
|
|
||||||
slice. Under the new Audita contract these are different instructions: nil
|
|
||||||
delegates to Audita's configuration/default sequence; empty passes an explicit
|
|
||||||
empty module argument and disables correction modules. Serialization therefore
|
|
||||||
silently changes behavior for a configuration that is subsequently reloaded.
|
|
||||||
|
|
||||||
Evidence: a temporary package test marshaled
|
|
||||||
`AuditaConfig{Binary: "audita", Timeout: "3h"}`, unmarshaled it into another
|
|
||||||
`AuditaConfig`, and required `Modules == nil`. It failed with output containing
|
|
||||||
`modules: []`. The test was removed after reproduction. This concerns direct
|
|
||||||
`yaml.Marshal` of the typed configuration; ordinary CLI `config show` uses
|
|
||||||
`MarshalEffectivePipeline` through a separate JSON/value-tree projection and
|
|
||||||
does not use this faulty path.
|
|
||||||
|
|
||||||
Required remediation:
|
|
||||||
|
|
||||||
- Make the direct safe YAML projection preserve nil as null or omission and
|
|
||||||
explicit empty as `[]`. Do not simply add `omitempty` to the slice: that would
|
|
||||||
instead erase the explicit empty selection.
|
|
||||||
- Keep credential serialization name-only and preserve module order/repetitions.
|
|
||||||
- Add a small round-trip regression covering nil, explicit empty, and an ordered
|
|
||||||
repeated selection; retain effective-output inspection coverage without
|
|
||||||
duplicating its whole test matrix.
|
|
||||||
|
|
||||||
## 2. Remove the unapproved manifest compatibility decoder
|
|
||||||
|
|
||||||
Priority: P2. Status: Complete.
|
|
||||||
|
|
||||||
Removed the permissive custom decoder; ordinary strict typed decoding now
|
|
||||||
applies to provenance as well. Replaced historical-acceptance coverage with
|
|
||||||
retired/unknown-field rejection tests, all of which failed before removal.
|
|
||||||
Current provenance round-trip coverage remains intact. Corrected the roadmap,
|
|
||||||
plan, internal contract, and operator guidance for narrow backed-up migration
|
|
||||||
without discarding execution/checkpoint state or changing resume authority.
|
|
||||||
|
|
||||||
Location: `internal/manifest/manifest.go:79-89`,
|
|
||||||
`internal/manifest/store_test.go:78`, and `docs/internal/manifest.md`'s decoding
|
|
||||||
contract. Also correct the conflicting migration language in the plan/roadmap.
|
|
||||||
|
|
||||||
The new `EffectiveConfigProvenance.UnmarshalJSON` bypasses the manifest store's
|
|
||||||
`DisallowUnknownFields` by using permissive `json.Unmarshal` for the entire
|
|
||||||
provenance object. It accepts retired `selected_profile` data and silently
|
|
||||||
discards it. It also silently accepts unknown current provenance fields,
|
|
||||||
including unknown nested selection fields, rather than limiting behavior to
|
|
||||||
the renamed label.
|
|
||||||
|
|
||||||
The user expressly selected a clean cutover without backward-compatibility
|
|
||||||
shims. This adds precisely such a shim and a new historical-input acceptance
|
|
||||||
guarantee. The regression test explicitly requires the old selection to load,
|
|
||||||
and the internal guide now declares permissive informational-field decoding.
|
|
||||||
|
|
||||||
The plan contributed to this divergence: it said existing generic decoding
|
|
||||||
would handle historical optional provenance and required old manifests to load.
|
|
||||||
That assumption was false; the baseline store already strictly decoded these
|
|
||||||
fields. Repetition in the plan, tests, and documentation does not authorize
|
|
||||||
overriding the user's clean-cutover decision.
|
|
||||||
|
|
||||||
Required remediation:
|
|
||||||
|
|
||||||
- Remove the custom compatibility unmarshaler and retain ordinary strict typed
|
|
||||||
decoding for the new `selected_overlay` representation. Do not add dual fields,
|
|
||||||
special retired-field handling, automatic manifest rewrites, or a format-version
|
|
||||||
bump just for this rename.
|
|
||||||
- Replace the historical-acceptance test with coverage for current provenance
|
|
||||||
round trips and unknown/retired provenance rejection through the real store.
|
|
||||||
- Correct the plan and current documentation to acknowledge the upgrade effect:
|
|
||||||
manifests with retired provenance require deliberate operator migration before
|
|
||||||
loading. Document narrow removal/renaming of retired informational provenance
|
|
||||||
on a backed-up manifest, preserving execution/checkpoint state; do not advise
|
|
||||||
deleting all session progress or rerunning everything.
|
|
||||||
- Keep provenance informational: this correction does not authorize adding it
|
|
||||||
to semantic resume keys or invalidating work based on overlay identity alone.
|
|
||||||
|
|
||||||
If transparent historical-manifest acceptance is desired instead, obtain an
|
|
||||||
explicit exception to the clean-cutover decision before retaining a compatibility
|
|
||||||
reader. Do not treat that exception as already granted.
|
|
||||||
|
|
||||||
## Review verification
|
|
||||||
|
|
||||||
The following records the original review, before remediation.
|
|
||||||
|
|
||||||
- Existing `go test ./...` passed.
|
|
||||||
- Race tests passed for subprocess, Audita, Notarius, config, stage, app, and
|
|
||||||
manifest packages after removing the temporary reproduction.
|
|
||||||
- `go vet ./...` passed.
|
|
||||||
- The temporary direct-YAML regression failed as described above.
|
|
||||||
- Source inspection and the new historical-provenance test establish finding 2;
|
|
||||||
`LocalStore.LoadReader` still uses strict decoding outside the custom hook.
|
|
||||||
|
|
||||||
The primary architecture is otherwise in place: ConfigKit v0.4.0 overlays,
|
|
||||||
shared named credential forwarding/redaction, a v2-only Audita subprocess
|
|
||||||
adapter, ordinary reports as diagnostics, and versioned ordered-module polish
|
|
||||||
evidence. No live model/provider runs were performed during this review.
|
|
||||||
|
|
||||||
## Migration remediation verification
|
|
||||||
|
|
||||||
Completed on 2026-09-25. Both new regressions failed before their respective
|
|
||||||
fixes. After remediation, `go test ./...`, `go test -race ./...`,
|
|
||||||
`go vet ./...`, `go build ./...`, documentation checks, maintained configuration
|
|
||||||
example checks, and `git diff --check` passed. No live provider runs were needed.
|
|
||||||
|
|
||||||
## Historical completed transcription review
|
|
||||||
|
|
||||||
Status: Complete.
|
|
||||||
|
|
||||||
Reviewed commits `7b0bf99` through `96b4e73` against the speaker-checkpoint and
|
|
||||||
upload-replay roadmap and the original user request. No production changes were
|
|
||||||
made during review. The two failures below were reproduced with temporary tests
|
|
||||||
using the existing stage fixtures; those temporary tests were removed afterward.
|
|
||||||
|
|
||||||
### 1. Reconcile Aggregate State Even When No Speaker Needs HTTP Work
|
|
||||||
|
|
||||||
Priority: P2. Status: Complete.
|
|
||||||
|
|
||||||
Implemented read-only aggregate identity/evidence checks before resume skips.
|
|
||||||
Regression tests cover removed inputs, missing/duplicate/mismatched outputs,
|
|
||||||
repair without HTTP requests, downstream invalidation, and exclusion of removed
|
|
||||||
speakers from merge without deleting their files. Equivalent path forms and
|
|
||||||
output ordering remain reusable. Focused app/stage tests and documentation
|
|
||||||
checks pass.
|
|
||||||
|
|
||||||
Location: `internal/stage/transcribe_resume.go:21` and the reconciliation result
|
|
||||||
consumed there.
|
|
||||||
|
|
||||||
`ValidateResume` returns reusable whenever `reconciliation.work` is empty. That
|
|
||||||
only establishes that the remaining speakers need no transcription; it does
|
|
||||||
not establish that the stored speaker collection and aggregate outputs match
|
|
||||||
the current input set. Removing a speaker while the remaining inputs are
|
|
||||||
unchanged produces an empty work list, so a succeeded record can be skipped
|
|
||||||
without pruning the removed speaker. Its old aggregate output can then remain
|
|
||||||
available to merge. Likewise, missing/inconsistent aggregate output references
|
|
||||||
are not repaired when all individual checkpoints remain valid. A prepare rerun
|
|
||||||
may already stale transcribe in some workflows, but the resume validator cannot
|
|
||||||
rely on that to satisfy its own current-input/output checks.
|
|
||||||
|
|
||||||
Reproduction: create complete alice/bob checkpoint records and aggregate
|
|
||||||
outputs with the existing fixture, mark the stage succeeded, remove bob from
|
|
||||||
the manifest's audio inputs, and call `ValidateResume`. It returns reusable
|
|
||||||
despite still retaining bob in the stored collection and aggregate outputs.
|
|
||||||
|
|
||||||
Required change:
|
|
||||||
|
|
||||||
- Distinguish no HTTP work from no reconciliation work. Validate that the
|
|
||||||
committed speaker set and aggregate transcript references represent the
|
|
||||||
reconciled current set, including relevant identity/evidence, before skipping.
|
|
||||||
- When only collection/output repair is needed, return non-resumable and let
|
|
||||||
normal execution checkpoint the pruned collection and rebuild aggregate
|
|
||||||
outputs without retranscribing reusable speakers. Preserve existing dependent
|
|
||||||
invalidation; do not force otherwise-current speaker jobs.
|
|
||||||
- Keep resume inspection read-only. Do not fix this by deleting incidental
|
|
||||||
transcript files or changing stage selection rules.
|
|
||||||
|
|
||||||
Verification: add removed-only input coverage (not just removal combined with
|
|
||||||
an added speaker), plus incomplete/inconsistent aggregate output coverage.
|
|
||||||
Exercise the runner skip path and assert zero additional WhisperX requests,
|
|
||||||
correct rebuilt outputs, and no removed speaker reaching merge.
|
|
||||||
|
|
||||||
### 2. Remove the Unrequested Positive Audio-Size Requirement
|
|
||||||
|
|
||||||
Priority: P2. Status: Complete.
|
|
||||||
|
|
||||||
Audio evidence now permits zero size while still rejecting negative values.
|
|
||||||
Regression tests verify zero-size manifest round trips, successful service
|
|
||||||
results being checkpointed and reused, and service rejection being propagated
|
|
||||||
without creating a completion record. Nonempty valid-JSON output validation is
|
|
||||||
unchanged. Both new success regressions failed before the fix.
|
|
||||||
|
|
||||||
Location: `internal/manifest/transcribe_state.go:95`.
|
|
||||||
|
|
||||||
The new record validator requires `AudioSize > 0`. Previously Narratio accepted
|
|
||||||
a regular `.flac` file and delegated transcription acceptance to WhisperX;
|
|
||||||
neither the user request nor the roadmap introduced minimum audio size or a new
|
|
||||||
audio-content validation policy. Zero-byte content still has a valid checksum
|
|
||||||
and can be represented by the checkpoint mechanism. The current check runs
|
|
||||||
after a successful response and output materialization, causing the entire
|
|
||||||
stage to fail instead of retaining the completed work.
|
|
||||||
|
|
||||||
Reproduction: prepare one speaker, replace its prepared audio with an empty
|
|
||||||
regular file, and use the existing successful fake WhisperX client. Stage
|
|
||||||
execution fails at checkpoint validation with `audio_size must be positive`.
|
|
||||||
This demonstrates the extra Narratio restriction; it does not assert that a
|
|
||||||
particular production WhisperX deployment accepts empty audio.
|
|
||||||
|
|
||||||
Required change:
|
|
||||||
|
|
||||||
- Permit zero audio size and reject negative sizes. Keep byte hashing and
|
|
||||||
size equality checks. Let the downstream service decide whether the input
|
|
||||||
can be transcribed, as before.
|
|
||||||
- Do not remove the nonempty valid-JSON output requirement, which has a separate
|
|
||||||
existing justification. Do not add a new early empty-audio rejection instead.
|
|
||||||
- Update any new tests/documentation that promote strictly positive input size
|
|
||||||
to a contract.
|
|
||||||
|
|
||||||
Verification: cover a zero-size record round-trip and successful adapter result
|
|
||||||
being checkpointed/reused for that input; retain negative-size rejection and
|
|
||||||
ordinary downstream-failure tests.
|
|
||||||
|
|
||||||
### Verification After Remediation
|
|
||||||
|
|
||||||
Completed on 2026-09-22 with Go 1.26.8: focused stage/application tests,
|
|
||||||
changed-package race tests, `go test ./...`, `go test -race ./...`,
|
|
||||||
`go vet ./...`, `go build ./...`, `go test ./internal/doccheck`,
|
|
||||||
`go test ./internal/config -run '^TestExamplesLoadAndValidate$'`, and
|
|
||||||
`git diff --check` all passed. Existing replay and cancellation regression
|
|
||||||
tests remain intact; the HTTP adapter required no changes.
|
|
||||||
@@ -1,183 +0,0 @@
|
|||||||
# Resumable Speaker Transcription and Replayable Uploads
|
|
||||||
|
|
||||||
Status: Implemented.
|
|
||||||
|
|
||||||
## Goal and User Intent
|
|
||||||
|
|
||||||
Preserve completed speaker transcriptions when another speaker fails, so an
|
|
||||||
ordinary run or resume does not repeat expensive successful work. Separately,
|
|
||||||
allow Go's HTTP transport to replay WhisperX uploads when it encounters a
|
|
||||||
recoverable connection or stream failure.
|
|
||||||
|
|
||||||
The motivating incident exhausted four transcription attempts for one speaker
|
|
||||||
after three other speakers had completed. The final error reported an HTTP/2
|
|
||||||
peer `PROTOCOL_ERROR` and an inability to replay the request body without
|
|
||||||
`Request.GetBody`.
|
|
||||||
|
|
||||||
These are related reliability improvements, not a promise to eliminate all
|
|
||||||
service failures. This document records the target state and scope. The
|
|
||||||
completed implementation sequence is retained in Git history; current behavior
|
|
||||||
is documented in the canonical guides linked below.
|
|
||||||
|
|
||||||
## Pre-implementation Limitations
|
|
||||||
|
|
||||||
The [transcribe stage](../internal/stage-transcribe.md) writes successful
|
|
||||||
responses into the invocation's run directory. It installs canonical transcripts
|
|
||||||
and returns its per-file metadata only after every speaker succeeds. A failure
|
|
||||||
therefore leaves no durable per-speaker progress that ordinary resume can use,
|
|
||||||
even though some completed JSON files may remain on disk.
|
|
||||||
|
|
||||||
The [WhisperX adapter](../integrations/whisperx.md) already retries requests at
|
|
||||||
the application level, reopening audio for each attempt. Its multipart request
|
|
||||||
body is streamed through a pipe and has no replay callback. Transport-level
|
|
||||||
recovery within an attempt cannot reconstruct a consumed body. Providing that
|
|
||||||
capability addresses the replay limitation, not the underlying peer protocol
|
|
||||||
error; persistent failures can still require service or proxy investigation.
|
|
||||||
|
|
||||||
## Targeted End State
|
|
||||||
|
|
||||||
### Durable Per-Speaker Completion
|
|
||||||
|
|
||||||
Each successfully transcribed speaker file is validated, saved, and recorded
|
|
||||||
durably before that work is treated as reusable. The session manifest remains
|
|
||||||
the progress authority. Follow the existing analyze-stage checkpoint pattern
|
|
||||||
without turning speakers into pipeline stages or introducing a general task
|
|
||||||
engine.
|
|
||||||
|
|
||||||
Ordinary execution reconciles the current prepared audio set with recorded
|
|
||||||
speaker results. It reuses valid completed work and schedules failed,
|
|
||||||
unattempted, missing, or obsolete results. A result is not reusable merely
|
|
||||||
because a matching filename exists. Evidence binds it to the speaker/audio
|
|
||||||
identity, audio content, Narratio-visible recognition settings, and the saved
|
|
||||||
transcript's integrity.
|
|
||||||
|
|
||||||
The relevant recognition settings remain the WhisperX service URL and language.
|
|
||||||
Retry count/delay, concurrency, timeout, credentials, and diagnostic locations
|
|
||||||
remain operational settings rather than reasons to discard completed results.
|
|
||||||
Changes to private service models or configuration remain an operator reason
|
|
||||||
to force transcription; Narratio does not inspect the service's private state.
|
|
||||||
|
|
||||||
Changes to individual audio inputs require replacement of affected results,
|
|
||||||
not automatic retranscription of unrelated unchanged speakers. New speakers
|
|
||||||
need transcription; removed speakers do not remain in the current aggregate
|
|
||||||
output set. Records must describe the inputs actually used, not grant reuse to
|
|
||||||
old bytes under a changed identity.
|
|
||||||
|
|
||||||
### Aggregate Completion, Failure, and Force
|
|
||||||
|
|
||||||
The overall stage succeeds only when every currently required speaker has a
|
|
||||||
validated, durably recorded result. Incomplete per-speaker progress does not
|
|
||||||
make the aggregate stage successful or authorize downstream consumption of an
|
|
||||||
incomplete collection. Existing dependent-stage invalidation remains in effect.
|
|
||||||
|
|
||||||
Retain bounded concurrency and the current fail-fast behavior: a speaker
|
|
||||||
failure cancels outstanding work. Results already checkpointed remain reusable
|
|
||||||
after failure, cancellation, or process interruption. A later ordinary run or
|
|
||||||
resume retries the remaining work; it does not need a new CLI command.
|
|
||||||
|
|
||||||
Checkpoint writes must be serialized so concurrently finishing speakers cannot
|
|
||||||
overwrite each other's progress. A failed persistence operation must not
|
|
||||||
advertise an unrecorded result as complete. Previously committed progress remains
|
|
||||||
the recovery authority, and checkpoint errors must be surfaced rather than
|
|
||||||
reported as successful transcription.
|
|
||||||
|
|
||||||
`--force` on transcribe regenerates all currently required speakers instead of
|
|
||||||
reusing their prior completions. Successful replacements are checkpointed too,
|
|
||||||
so an ordinary retry after a failed forced invocation can retain the newly
|
|
||||||
completed work. Old results for speakers not successfully regenerated must not
|
|
||||||
satisfy that unfinished forced replacement on the next ordinary retry.
|
|
||||||
|
|
||||||
This deliberately relaxes the current all-speakers-before-canonical-installation
|
|
||||||
implementation: individual durable results may exist while the stage remains
|
|
||||||
failed or incomplete. The all-speakers-before-stage-success boundary remains.
|
|
||||||
|
|
||||||
### Replayable WhisperX Requests
|
|
||||||
|
|
||||||
Provide `Request.GetBody` so the HTTP transport can obtain a fresh body for the
|
|
||||||
same request. Replay reopens the audio and reproduces the multipart boundary,
|
|
||||||
filename, fields, and framing used by the original request. Independent bodies
|
|
||||||
must not share a consumed reader or mutable read position.
|
|
||||||
|
|
||||||
Preserve bounded-memory streaming rather than buffering entire audio files in
|
|
||||||
memory. Correctly close every original and replay body and its audio resources;
|
|
||||||
preserve source-read errors and cancellation, including partial uploads and
|
|
||||||
early server responses. Successful response handling must not accidentally wait
|
|
||||||
on, or report errors solely from, an abandoned body instead of the replay that
|
|
||||||
produced the response.
|
|
||||||
|
|
||||||
Keep the existing application-level retry count, delay, classification, and
|
|
||||||
per-attempt timeout semantics. Transport replays occur within an application
|
|
||||||
attempt and its context; they are not additional Narratio-configured attempts.
|
|
||||||
Do not add another custom retry loop, silently increase retries, or disable
|
|
||||||
HTTP/2 globally as a substitute for replay support.
|
|
||||||
|
|
||||||
The adapter still validates and installs only successful JSON responses.
|
|
||||||
Request replay does not provide exactly-once server execution: a lost response
|
|
||||||
can cause repeated transcription work, as can existing application retries.
|
|
||||||
No new service-side idempotency protocol is required by this feature.
|
|
||||||
|
|
||||||
## Required Change Areas
|
|
||||||
|
|
||||||
- **Manifest and persistence:** Add transcribe-owned per-speaker progress and
|
|
||||||
evidence, with safe checkpoint updates and preservation through runner failure
|
|
||||||
handling. Review manifest validation, copying, serialization, and existing
|
|
||||||
publish/restore handling wherever the new records pass through those paths.
|
|
||||||
- **Stage execution and reuse:** Reconcile speaker records before scheduling,
|
|
||||||
checkpoint validated completions, rebuild aggregate outputs from the current
|
|
||||||
set, and account for partial progress in ordinary and forced execution.
|
|
||||||
Review successful-stage reuse as well as failed-stage retries so stale audio
|
|
||||||
or missing/corrupt transcript evidence is not bypassed by an aggregate skip.
|
|
||||||
- **Artifact lifecycle:** Use existing path, installation, integrity, and manifest
|
|
||||||
mechanisms. Ensure checkpointed results do not depend on an ephemeral run
|
|
||||||
directory surviving cleanup. Do not introduce a second authoritative ledger
|
|
||||||
or infer completion by scanning abandoned runs.
|
|
||||||
- **HTTP adapter:** Make multipart bodies reproducible and correctly manage
|
|
||||||
every replay's lifetime, without changing the WhisperX HTTP schema or requiring
|
|
||||||
an upstream service change.
|
|
||||||
- **Tests:** Cover per-speaker recovery after a later failure, interruption and
|
|
||||||
checkpoint failure; changed/missing inputs or outputs; force followed by an
|
|
||||||
ordinary retry; concurrent successful completions; and aggregate downstream
|
|
||||||
gating. Extend existing fixtures rather than duplicating analyze's complete
|
|
||||||
test suite. Exercise actual body reconstruction after partial consumption,
|
|
||||||
multipart equivalence, cancellation/resource cleanup, and existing bounded
|
|
||||||
streaming and retry behavior—not just the presence of a callback. Default
|
|
||||||
tests remain offline and use local/fake HTTP boundaries, never paid services.
|
|
||||||
- **Documentation:** Update the canonical
|
|
||||||
[stage guide](../internal/stage-transcribe.md),
|
|
||||||
[manifest guide](../internal/manifest.md),
|
|
||||||
[WhisperX contract](../integrations/whisperx.md),
|
|
||||||
[operations guide](../operations.md), and
|
|
||||||
[troubleshooting guide](../troubleshooting.md) when implemented. Explain
|
|
||||||
partial completion, ordinary retry versus force, and the distinction between
|
|
||||||
request replay limitations and persistent peer protocol failures.
|
|
||||||
|
|
||||||
## Compatibility and Scope Boundaries
|
|
||||||
|
|
||||||
Existing speaker identities, raw transcript formats, and the fixed pipeline
|
|
||||||
order remain unchanged. Existing manifests remain readable, but must not be
|
|
||||||
treated as containing per-speaker evidence they never recorded. Recovery relies
|
|
||||||
on verified recorded evidence, not guessed associations between old transcripts
|
|
||||||
and current audio. No general legacy-migration framework is part of the feature.
|
|
||||||
|
|
||||||
Automatic adoption of unrecorded outputs from previously failed runs is outside
|
|
||||||
this feature. Such files may be recoverable after verifying their inputs, but
|
|
||||||
their presence alone does not prove completion. No recovery/import command,
|
|
||||||
speaker-selection CLI, historical invocation ledger, new service configuration
|
|
||||||
discovery, or broader orchestration refactor is included.
|
|
||||||
|
|
||||||
The feature does not diagnose the remote service/proxy's underlying HTTP/2
|
|
||||||
problem, guarantee recovery from persistent protocol errors, or change the
|
|
||||||
policy for continuing unrelated work after failure.
|
|
||||||
|
|
||||||
## Completion Criteria
|
|
||||||
|
|
||||||
For speakers A, B, C, and D: if A and B are checkpointed, C fails, and D has not
|
|
||||||
completed, ordinary resume retains A and B, retries C, and completes D. No
|
|
||||||
downstream stage receives an incomplete successful transcription collection.
|
|
||||||
Force replaces all four, while an ordinary retry can reuse checkpoints from
|
|
||||||
that forced replacement attempt.
|
|
||||||
|
|
||||||
The HTTP transport can reconstruct the upload after consuming the original
|
|
||||||
body, without whole-file memory buffering, lost source errors, or stranded
|
|
||||||
upload resources. A persistent peer error still fails normally after the
|
|
||||||
configured application attempts, without discarding checkpointed speakers.
|
|
||||||
280
docs/roadmap/workspace.md
Normal file
280
docs/roadmap/workspace.md
Normal file
@@ -0,0 +1,280 @@
|
|||||||
|
# Session workspace organization
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Give operators predictable locations for session inputs, completed outputs,
|
||||||
|
logs, and debug evidence. Apply the taxonomy in
|
||||||
|
[ADR 0001](../adr/0001-classify-session-content.md) and the ownership boundary in
|
||||||
|
[ADR 0002](../adr/0002-assign-subprocess-content-ownership.md).
|
||||||
|
|
||||||
|
This roadmap defines the target behavior and required changes. Implementation
|
||||||
|
sequencing belongs in a subsequent implementation plan. The ADRs remain
|
||||||
|
Proposed pending their acceptance.
|
||||||
|
|
||||||
|
## Confirmed Requirements
|
||||||
|
|
||||||
|
- Completed artifacts occupy a flat `artifacts/` directory. Intermediate
|
||||||
|
products such as `session_bounds.json` belong here.
|
||||||
|
- Combined transcripts occupy `transcripts/` directly. Initial per-speaker
|
||||||
|
transcripts occupy a subdirectory beneath it.
|
||||||
|
- Prepared external audio occupies `audio/`; other prepared external inputs
|
||||||
|
occupy `inputs/`. Outputs consumed by later stages retain their output paths.
|
||||||
|
- Logs and Debug use matching latest-attempt views: `logs/<stage>` and
|
||||||
|
`debug/<stage>` are symlinks to the producing run's directories. Both views
|
||||||
|
advance when a stage starts an actual attempt, including attempts that fail.
|
||||||
|
A skipped stage leaves its previous views intact.
|
||||||
|
- Execution reports and invocation records are Logs. Historical Logs and Debug
|
||||||
|
remain under their producing runs, subject to cleanup.
|
||||||
|
- Narratio can selectively request supported subprocess debug capture through
|
||||||
|
configuration. Omission preserves application configuration and defaults;
|
||||||
|
Narratio needs no explicit downstream debug-disable override.
|
||||||
|
- Prepared session audio is the single retained Narratio-managed audio copy.
|
||||||
|
Remove Narratio's separate persistent audio cache and spool duplicates.
|
||||||
|
- Configurations that produce colliding artifact names or destinations fail
|
||||||
|
validation before execution. Validation covers the effective pipeline,
|
||||||
|
including expanded character families and built-in artifact destinations.
|
||||||
|
- Narratio selects input, output, log, and debug paths. Subprocess applications
|
||||||
|
own their working State and Cache through their supported configuration.
|
||||||
|
- A dedicated cache root such as `/var/cache/notarius` is a deployment
|
||||||
|
recommendation. The application owns its cache defaults, internal layout,
|
||||||
|
identity, and reuse semantics. Narratio session cleanup respects that boundary.
|
||||||
|
- Narratio retains its own manifest, recovery records, and managed staging State.
|
||||||
|
- This is a clean cutover for newly prepared sessions. Existing-session migration
|
||||||
|
and backward compatibility shims are outside the feature.
|
||||||
|
- Treatment of older completed files after invalidation or failed replacement
|
||||||
|
remains unchanged, including their availability through manifest-backed
|
||||||
|
resolution. Directory reorganization does not authorize new stale-file
|
||||||
|
deletion, automatic fallback, or rollback behavior.
|
||||||
|
|
||||||
|
## Current Baseline
|
||||||
|
|
||||||
|
The [operator guide](../operations.md#local-state-layout) owns the current
|
||||||
|
physical layout. Relevant differences from the target are:
|
||||||
|
|
||||||
|
- Extraction moves the complete Notarius bundle to
|
||||||
|
`artifacts/notarius/<run_id>/`. Resume evidence and artifact resolution depend
|
||||||
|
on that bundle and its index.
|
||||||
|
- Merge and normalize promote Seriatim execution reports into `artifacts/`.
|
||||||
|
- Analysis output paths and character-family patterns can introduce nested
|
||||||
|
artifact directories. Output-path configuration also permits locations that
|
||||||
|
need reconciliation with the selected directory categories.
|
||||||
|
- Standard combined transcript paths already match the target. Layout creation
|
||||||
|
also creates an unused `transcripts/trimmed/` directory.
|
||||||
|
- Most subprocess diagnostics live under individual run directories. Root-level
|
||||||
|
log paths lack a consistent latest-attempt view. Audita reports sit beside
|
||||||
|
its staged transcript, and restore writes a separate top-level report.
|
||||||
|
- Prepared previous-session inputs occupy `previous/`. Narratio-owned reference
|
||||||
|
snapshots supplied to Notarius occupy session `cache/notarius/references/`.
|
||||||
|
These snapshots are distinct from Notarius's own execution caches.
|
||||||
|
- Audita debug placement follows downstream configuration. Narratio does not
|
||||||
|
expose Notarius debug capture, and Scriptorium render-debug placement varies.
|
||||||
|
- Narratio maintains separate S3 audio cache and spool paths in addition to the
|
||||||
|
prepared session audio copy.
|
||||||
|
|
||||||
|
## Target Layout And Ownership
|
||||||
|
|
||||||
|
Retain the configurable workspace root and its current system-wide default,
|
||||||
|
`/var/lib/narratio`. Sessions remain under
|
||||||
|
`/var/lib/narratio/work/<campaign>/<session>` by default. The following paths
|
||||||
|
express the selected categories:
|
||||||
|
|
||||||
|
| Path | Contents and role |
|
||||||
|
| --- | --- |
|
||||||
|
| `manifest.json` | Narratio's durable progress and output references. |
|
||||||
|
| `artifacts/<filename>` | Completed artifact payloads, including session bounds. |
|
||||||
|
| `transcripts/<filename>` | Completed combined transcripts and rendered transcripts. |
|
||||||
|
| `transcripts/raw/<speaker>.json` | Completed initial per-speaker transcripts. |
|
||||||
|
| `audio/` | Prepared external audio. |
|
||||||
|
| `inputs/` | Prepared configuration, references, and previous-session inputs. |
|
||||||
|
| `logs/<stage>` | Symlink to the latest attempt's run-local logs and execution reports. |
|
||||||
|
| `debug/<stage>` | Symlink to the latest attempt's run-local debug directory, empty when no capture is produced. |
|
||||||
|
| `runs/<run_id>/<stage>/logs/` | Actual logs and execution reports for that attempt. |
|
||||||
|
| `runs/<run_id>/<stage>/debug/` | Actual debug captures for that attempt, including retained state snapshots. |
|
||||||
|
| `runs/<run_id>/` | Narratio staging, original tool bundles, and retained execution evidence. |
|
||||||
|
|
||||||
|
For example, the latest views use relative links within the session:
|
||||||
|
|
||||||
|
```text
|
||||||
|
logs/polish -> ../runs/<run_id>/polish/logs/
|
||||||
|
debug/polish -> ../runs/<run_id>/polish/debug/
|
||||||
|
```
|
||||||
|
|
||||||
|
Each stage's latest attempt can belong to a different run. Producers write to
|
||||||
|
the actual run paths; the symlinks provide operator navigation without duplicate
|
||||||
|
diagnostic storage.
|
||||||
|
|
||||||
|
Narratio's lock and restore marker remain its own State. Their current placement
|
||||||
|
can remain; introducing another root-level State directory is unnecessary for
|
||||||
|
this feature. Generated records that describe an invocation belong with Logs;
|
||||||
|
configuration actually supplied as an input follows its input or staging role.
|
||||||
|
|
||||||
|
Subprocesses may create internal working directories wherever their configuration
|
||||||
|
directs. Narratio-selected staging destinations for result bundles remain valid
|
||||||
|
under ADR 0002. Cache locations are documented as operator recommendations using
|
||||||
|
each application's existing configuration surface.
|
||||||
|
|
||||||
|
## Required Changes
|
||||||
|
|
||||||
|
### Output paths and configuration
|
||||||
|
|
||||||
|
Centralize the revised paths in the existing path owner. Apply the flat artifact
|
||||||
|
rule to explicit artifacts, expanded families, extraction outputs, and session
|
||||||
|
bounds. Preserve logical source identities used by dependencies and publication.
|
||||||
|
Keep explicit analysis filenames and require flat destinations. Derive extraction
|
||||||
|
filenames from configured extraction keys with a `.json` extension, with an
|
||||||
|
explicit extraction filename override for naming preferences or collisions.
|
||||||
|
Retain `session_bounds.json` as the default bounds filename. Do not silently
|
||||||
|
rename conflicting files. Report conflicting producers and the shared destination
|
||||||
|
in configuration errors. Validate the effective configuration after composition
|
||||||
|
and family expansion.
|
||||||
|
|
||||||
|
Keep combined transcript destinations directly beneath `transcripts/`. Remove
|
||||||
|
obsolete directory scaffolding and reconcile configurable output paths with
|
||||||
|
their category. Local path changes do not require flattening explicitly
|
||||||
|
configured remote publish destinations.
|
||||||
|
|
||||||
|
### Notarius result handling and reuse
|
||||||
|
|
||||||
|
Receive and validate the complete Notarius bundle in Narratio staging. Promote
|
||||||
|
selected accepted payloads to their flat artifact destinations. Classify the
|
||||||
|
receipt, warnings, rejection summaries, and diagnostics as Logs. Keep bundle
|
||||||
|
indexes and other management metadata with the bundle or Narratio State according
|
||||||
|
to their use.
|
||||||
|
|
||||||
|
Revise extraction evidence, catalog hydration, and resume checks to resolve
|
||||||
|
promoted products independently of the old `artifacts/notarius/` layout. Retain
|
||||||
|
the identity, provenance, contract, and checksum evidence needed for current
|
||||||
|
reuse behavior. Historical bundles may remain available for inspection under
|
||||||
|
their existing retention semantics; relocating them beneath `runs/` must not
|
||||||
|
silently shorten their lifetime through run cleanup.
|
||||||
|
|
||||||
|
Preserve ordinary resume and forced-extraction behavior. Subprocess caches remain
|
||||||
|
under Notarius's control.
|
||||||
|
|
||||||
|
### Inputs
|
||||||
|
|
||||||
|
Place prepared previous-session material beneath `inputs/previous/`. Place the
|
||||||
|
stable reference snapshots Narratio supplies to Notarius beneath
|
||||||
|
`inputs/references/`, retaining their content identities where needed for reuse.
|
||||||
|
Update preparation, input resolution, manifest references, and restore mappings.
|
||||||
|
Keep source configuration ownership and prepared-file validation unchanged.
|
||||||
|
|
||||||
|
### Audio acquisition
|
||||||
|
|
||||||
|
Simplify acquisition to one prepared session copy under `audio/`. Remove the
|
||||||
|
separate Narratio S3 audio cache and routine retained spool copies, together with
|
||||||
|
their obsolete configuration, manifest bookkeeping, and cleanup controls.
|
||||||
|
Preparation may use temporary download files before installing validated audio.
|
||||||
|
Preserve reuse of valid prepared audio and update restore to use the same layout.
|
||||||
|
|
||||||
|
Recreating a session after its prepared audio is removed requires fetching the
|
||||||
|
source again. Original recordings remain outside this cleanup change. Removing
|
||||||
|
spool/cache handling does not authorize new deletion of prepared session audio.
|
||||||
|
Subprocess caches remain independently configured and managed.
|
||||||
|
|
||||||
|
### Logs and execution reports
|
||||||
|
|
||||||
|
Provide one consistent latest-attempt view per stage. Include failed attempts;
|
||||||
|
a skipped stage leaves its previous view intact. Distinguish multiple applications
|
||||||
|
or artifact invocations within a stage through their filenames. Route Seriatim
|
||||||
|
reports, Audita reports, Notarius diagnostic records, and Narratio invocation
|
||||||
|
records through this model. Treat restore execution as its own diagnostic group
|
||||||
|
under `logs/restore/`, using run-local evidence and a latest-attempt view.
|
||||||
|
|
||||||
|
Prevent a new attempt from presenting old diagnostic files as newly generated
|
||||||
|
ones. At the start of each actual stage attempt, create its run-local log and
|
||||||
|
debug directories and refresh both latest symlinks. An attempt without debug
|
||||||
|
output exposes an empty debug directory rather than an older capture. Preserve
|
||||||
|
subprocess errors and available evidence on failure. Retain existing
|
||||||
|
captured-stream redaction and limits.
|
||||||
|
|
||||||
|
Keep historical files at their run paths; rotating the links does not move files.
|
||||||
|
Run cleanup must preserve directories targeted by current latest links. Do not
|
||||||
|
introduce an automatic history age or count limit. Publication and manifest
|
||||||
|
diagnostic references use actual run paths. Adjust path handling for these
|
||||||
|
Narratio-managed navigation links without relying on arbitrary symlink traversal.
|
||||||
|
|
||||||
|
### Debug controls and placement
|
||||||
|
|
||||||
|
Add selective Narratio configuration for Audita and Notarius debug capture using
|
||||||
|
their supported enabling CLI flags. An enabled Narratio selector requests
|
||||||
|
capture; an omitted or false selector passes no debug override and preserves the
|
||||||
|
application's configured/default behavior. Do not add a downstream disable flag.
|
||||||
|
|
||||||
|
Supply the actual run-local debug directories, exposed through `debug/polish`
|
||||||
|
and `debug/extract`. Control the destination when capture can be enabled through
|
||||||
|
downstream configuration as well, including Audita overlays, using supported
|
||||||
|
destination controls without changing capture enablement. Audita's debug
|
||||||
|
work-directory option selects diagnostic storage and belongs to this placement
|
||||||
|
responsibility.
|
||||||
|
|
||||||
|
Route Scriptorium's existing analysis and bounds render-debug products to the
|
||||||
|
run-local directories exposed through `debug/analyze` and `debug/trim`. Preserve
|
||||||
|
its existing per-artifact selection capability. Seriatim requires no invented
|
||||||
|
debug mode; its ordinary reports are
|
||||||
|
Logs. Subprocess-defined bundle contents and nested run directories are allowed
|
||||||
|
beneath the selected run-local debug root. Logs and Debug share the same
|
||||||
|
latest-attempt semantics and cleanup protection.
|
||||||
|
|
||||||
|
Keep new full Audita and Notarius debug bundles local in this feature. Preserve
|
||||||
|
publication of currently declared diagnostics, including existing render-debug
|
||||||
|
products. Enabling capture does not implicitly add full debug bundles to remote
|
||||||
|
archives.
|
||||||
|
|
||||||
|
Debug controls govern capture when a stage executes. They do not independently
|
||||||
|
require regeneration of valid substantive outputs. Document the existing force
|
||||||
|
workflow for obtaining fresh diagnostic evidence when a stage would be reused.
|
||||||
|
Preserve downstream failure semantics for diagnostic writes and the existing
|
||||||
|
boundary of Narratio's captured-stream redaction.
|
||||||
|
|
||||||
|
### Audita destination support
|
||||||
|
|
||||||
|
Request upstream support for independently selecting the transcript output,
|
||||||
|
ordinary report/log directory, and debug/retained working directory, then adopt
|
||||||
|
a supporting release. Audita currently ignores `--report-dir` when transcript
|
||||||
|
output is a file; honoring that destination is the principal missing capability.
|
||||||
|
Narratio continues to capture subprocess stdout and stderr itself.
|
||||||
|
|
||||||
|
Direct ordinary reports, including failure reports, to the actual polish log
|
||||||
|
directory, the transcript to its staged product destination, and retained debug
|
||||||
|
material to the actual polish debug directory. This feature uses the supported
|
||||||
|
upstream controls in a clean cutover without version-based compatibility branches.
|
||||||
|
|
||||||
|
### Manifest, publication, restore, and cleanup
|
||||||
|
|
||||||
|
Update all consumers of changed paths and file categories together. Preserve
|
||||||
|
per-speaker and per-artifact completed-work reuse. Keep publication driven by
|
||||||
|
declared products and diagnostics, with new full debug bundles remaining local.
|
||||||
|
Restore new-format products and inputs to their new locations.
|
||||||
|
|
||||||
|
Define an explicit way to identify supported session state for the clean
|
||||||
|
cutover. Document regeneration with the new version and manual configuration
|
||||||
|
updates. Avoid accepting old state through path fallbacks or silently rewriting
|
||||||
|
old local sessions or remote snapshots.
|
||||||
|
|
||||||
|
Preserve existing invalidation and failed-replacement behavior. Review retention
|
||||||
|
by content role before changing cleanup targets, especially when durable products
|
||||||
|
or historical bundles move. Run cleanup preserves the current log and debug
|
||||||
|
link targets; explicit removal of an entire session removes its local views
|
||||||
|
with it. Subprocess working State and Cache remain outside Narratio's cleanup
|
||||||
|
responsibility.
|
||||||
|
|
||||||
|
### Documentation and verification
|
||||||
|
|
||||||
|
Update configuration examples, the operator guide, adapter contracts, workspace
|
||||||
|
internals, and the architecture policy when implementation lands. Replace the
|
||||||
|
current architectural assumption that extraction requires a complete immutable
|
||||||
|
bundle beneath `artifacts/` with the selected product-promotion model. Retire
|
||||||
|
policy and documentation for Narratio's removed audio cache/spool lifecycle and
|
||||||
|
document the managed latest-attempt symlinks. Keep per-application cache locations
|
||||||
|
as deployment recommendations owned by each application's configuration.
|
||||||
|
|
||||||
|
Use focused behavioral coverage for flat output placement, collision rejection,
|
||||||
|
latest-attempt diagnostics on success and failure, debug selection and routing,
|
||||||
|
unchanged completed-work reuse, failed replacement, and new-format publish/restore.
|
||||||
|
Cover empty debug views after attempts without capture, preserved views for
|
||||||
|
skipped stages, cleanup protection of latest targets, and audio acquisition,
|
||||||
|
reuse, and restore without persistent spool/cache duplicates. Exercise cleanup
|
||||||
|
against products and separately owned caches. Use temporary filesystems and
|
||||||
|
subprocess doubles; default tests remain offline and independent
|
||||||
|
of sibling checkouts or paid providers.
|
||||||
@@ -90,12 +90,12 @@ Symptom:
|
|||||||
|
|
||||||
Likely cause:
|
Likely cause:
|
||||||
|
|
||||||
- the campaign `party.yml` is an unversioned legacy document, or names a
|
- the campaign party main document is unversioned, or names a
|
||||||
schema other than `narratio.party.v1`.
|
schema other than `narratio.party.v1`.
|
||||||
|
|
||||||
Safe fix:
|
Safe fix:
|
||||||
|
|
||||||
- replace the file with one exact, single-document
|
- replace the main file with a versioned
|
||||||
[`narratio.party.v1` party](./integrations/party.md); do not add a version
|
[`narratio.party.v1` party](./integrations/party.md); do not add a version
|
||||||
marker to an otherwise incompatible legacy structure. The versioned party is
|
marker to an otherwise incompatible legacy structure. The versioned party is
|
||||||
the only configured roster authority.
|
the only configured roster authority.
|
||||||
@@ -118,7 +118,8 @@ narratio config sources --config /path/pipeline.yml --overlay testing
|
|||||||
Add `--campaign` or `--campaign-file` when the pipeline has party-driven
|
Add `--campaign` or `--campaign-file` when the pipeline has party-driven
|
||||||
artifact families. The output identifies each effective logical field's root,
|
artifact families. The output identifies each effective logical field's root,
|
||||||
import, overlay, default, campaign, party, or family source without printing
|
import, overlay, default, campaign, party, or family source without printing
|
||||||
the field value or credential contents.
|
the field value or credential contents. Empty optional import selections are
|
||||||
|
reported separately; selected invalid files still fail.
|
||||||
|
|
||||||
Safe fix:
|
Safe fix:
|
||||||
|
|
||||||
@@ -739,6 +740,20 @@ manifest-owned.
|
|||||||
Relevant references: [Operations: Stage Execution and Continuation Behavior](./operations.md#stage-execution-and-continuation-behavior)
|
Relevant references: [Operations: Stage Execution and Continuation Behavior](./operations.md#stage-execution-and-continuation-behavior)
|
||||||
and [Manifest Internals](./internal/manifest.md#transcribe-owned-speaker-state).
|
and [Manifest Internals](./internal/manifest.md#transcribe-owned-speaker-state).
|
||||||
|
|
||||||
|
## Scriptorium returns HTTP 401 during trim or analyze
|
||||||
|
|
||||||
|
Check that Narratio's pipeline selects the credential names required by
|
||||||
|
Scriptorium, for example `scriptorium.credentials: [OPENROUTER_API_KEY]`.
|
||||||
|
Provision the values through the existing environment or secrets directory;
|
||||||
|
exporting a key without selecting it does not forward it to the child process.
|
||||||
|
See [Scriptorium credentials](config.md#scriptorium-credentials).
|
||||||
|
|
||||||
|
Once corrected, retry the failed run normally; forcing previously successful
|
||||||
|
transcription or analysis is unnecessary. If authentication still fails, check
|
||||||
|
the selected Scriptorium backend, credential validity, and provider access
|
||||||
|
without printing keys. A 401 can indicate an invalid key as well as a missing
|
||||||
|
one.
|
||||||
|
|
||||||
## Scriptorium private input changed without a rerun
|
## Scriptorium private input changed without a rerun
|
||||||
|
|
||||||
Symptom:
|
Symptom:
|
||||||
@@ -944,7 +959,7 @@ Symptom:
|
|||||||
Likely causes:
|
Likely causes:
|
||||||
|
|
||||||
- missing, unreadable, or invalid explicit `--secrets-dir`;
|
- missing, unreadable, or invalid explicit `--secrets-dir`;
|
||||||
- invalid entries in the conventional `secrets/` directory beside the root pipeline;
|
- invalid entries in `/usr/local/etc/narratio/secrets`;
|
||||||
- missing credential environment variables;
|
- missing credential environment variables;
|
||||||
- invalid S3 endpoint/bucket settings.
|
- invalid S3 endpoint/bucket settings.
|
||||||
|
|
||||||
|
|||||||
@@ -12,12 +12,18 @@ in the [configuration reference](../docs/config.md).
|
|||||||
- [Production-shaped pipeline](pipeline.production.yml): S3 storage, publish,
|
- [Production-shaped pipeline](pipeline.production.yml): S3 storage, publish,
|
||||||
external tools, and configured Scriptorium artifacts.
|
external tools, and configured Scriptorium artifacts.
|
||||||
- [Production-base/testing-overlay bundle](production-testing/pipeline.yml):
|
- [Production-base/testing-overlay bundle](production-testing/pipeline.yml):
|
||||||
explicit `conf.d` imports, one ordinary artifact per `artifacts/<key>.yml`,
|
explicit required `conf.d` imports, an optional local import, destination-mounted
|
||||||
one family per `artifact-families/<key>.yml`, and the fixed
|
artifact files, a YAML-filtered directory of keyed families, and the fixed
|
||||||
`overlays/testing.yml` overlay. Production values live in the base. The
|
`overlays/testing.yml` overlay. Production values live in the base. The
|
||||||
bundle demonstrates an input-only artifact dependency, two character families
|
bundle demonstrates an input-only artifact dependency, two character families
|
||||||
sharing the campaign party, and a testing-only disabled artifact. Inspect it
|
sharing the campaign party, and a testing-only disabled artifact. The testing
|
||||||
offline with:
|
overlay's `testing_notes` artifact inherits the recap prompt, inputs, and
|
||||||
|
testing profile while retaining its disabled status and separate output path.
|
||||||
|
The testing overlay upserts the transcript publish rule by `source`. A
|
||||||
|
destination key defines each artifact ID; filenames do not. Full-root and
|
||||||
|
disjoint definitions are also valid. Upsert replaces a matching list record
|
||||||
|
as a whole; empty append or upsert contributions leave existing entries intact.
|
||||||
|
Inspect it offline with:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
narratio config validate --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml
|
narratio config validate --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml
|
||||||
@@ -43,7 +49,9 @@ with the sample campaign and a compatible local- or S3-audio session.
|
|||||||
|
|
||||||
- [Sample campaign](campaigns/sample-campaign/campaign.yml), its
|
- [Sample campaign](campaigns/sample-campaign/campaign.yml), its
|
||||||
[session template](campaigns/sample-campaign/session.template.yml), and its
|
[session template](campaigns/sample-campaign/session.template.yml), and its
|
||||||
adjacent stable inputs provide a complete campaign directory shape.
|
adjacent stable inputs provide a complete campaign directory shape. Its
|
||||||
|
imported settings and split party demonstrate local secondary imports;
|
||||||
|
relative resources follow the file that supplies each value.
|
||||||
- [Local-audio session](session.local-audio.yml) and
|
- [Local-audio session](session.local-audio.yml) and
|
||||||
[S3-audio session](session.s3-audio.yml) are concrete session files.
|
[S3-audio session](session.s3-audio.yml) are concrete session files.
|
||||||
- [Session template](session.template.yml) and the campaign-local equivalent
|
- [Session template](session.template.yml) and the campaign-local equivalent
|
||||||
@@ -76,8 +84,8 @@ names, or the Narratio credential lists must be changed to match. See the
|
|||||||
[Audita v2 migration guide](https://gitea.maximumdirect.net/eric/audita/src/tag/v2.0.0/docs/migrations/v2.md)
|
[Audita v2 migration guide](https://gitea.maximumdirect.net/eric/audita/src/tag/v2.0.0/docs/migrations/v2.md)
|
||||||
for maintained downstream configuration examples.
|
for maintained downstream configuration examples.
|
||||||
|
|
||||||
For a deployed bundle, keep credential files out of source control in a
|
For a deployed bundle, keep credential files out of source control in the
|
||||||
`secrets/` directory beside the root `pipeline.yml`, one file per referenced
|
conventional `/usr/local/etc/narratio/secrets` directory, one file per referenced
|
||||||
environment-variable name, or select another directory with `--secrets-dir`.
|
environment-variable name, or select another directory with `--secrets-dir`.
|
||||||
Static S3 credentials are optional: omit both S3 credential references to use
|
Static S3 credentials are optional: omit both S3 credential references to use
|
||||||
the AWS SDK discovery chain.
|
the AWS SDK discovery chain.
|
||||||
|
|||||||
@@ -1,8 +1,5 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: fragments/inputs.yml
|
||||||
|
required: true
|
||||||
campaign_id: sample-campaign
|
campaign_id: sample-campaign
|
||||||
session_template_file: ./session.template.yml
|
|
||||||
inputs:
|
|
||||||
speakers_file: ./speakers.yml
|
|
||||||
autocorrect_file: ./autocorrect.yml
|
|
||||||
glossary_file: ./glossary.yml
|
|
||||||
party_file: ./party.yml
|
|
||||||
spell_catalog_file: ./spell_catalog.json
|
|
||||||
|
|||||||
12
examples/campaigns/sample-campaign/fragments/brenna.yml
Normal file
12
examples/campaigns/sample-campaign/fragments/brenna.yml
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
brenna:
|
||||||
|
player:
|
||||||
|
name: Rowan Hale
|
||||||
|
character:
|
||||||
|
name: Brenna
|
||||||
|
alias:
|
||||||
|
- Shield of Dawn
|
||||||
|
classes:
|
||||||
|
- name: paladin
|
||||||
|
level: 6
|
||||||
|
- name: warlock
|
||||||
|
level: 2
|
||||||
7
examples/campaigns/sample-campaign/fragments/inputs.yml
Normal file
7
examples/campaigns/sample-campaign/fragments/inputs.yml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
session_template_file: ../session.template.yml
|
||||||
|
inputs:
|
||||||
|
speakers_file: ../speakers.yml
|
||||||
|
autocorrect_file: ../autocorrect.yml
|
||||||
|
glossary_file: ../glossary.yml
|
||||||
|
party_file: ../party.yml
|
||||||
|
spell_catalog_file: ../spell_catalog.json
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
schema_version: narratio.party.v1
|
schema_version: narratio.party.v1
|
||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: fragments/brenna.yml
|
||||||
|
destination: [characters]
|
||||||
|
required: true
|
||||||
|
|
||||||
characters:
|
characters:
|
||||||
arannis:
|
arannis:
|
||||||
@@ -12,15 +17,3 @@ characters:
|
|||||||
classes:
|
classes:
|
||||||
- name: wizard
|
- name: wizard
|
||||||
level: 8
|
level: 8
|
||||||
brenna:
|
|
||||||
player:
|
|
||||||
name: Rowan Hale
|
|
||||||
character:
|
|
||||||
name: Brenna
|
|
||||||
alias:
|
|
||||||
- Shield of Dawn
|
|
||||||
classes:
|
|
||||||
- name: paladin
|
|
||||||
level: 6
|
|
||||||
- name: warlock
|
|
||||||
level: 2
|
|
||||||
|
|||||||
@@ -133,7 +133,7 @@ notarius:
|
|||||||
# Optionally select a Notarius ConfigKit overlay when extraction runs. This
|
# Optionally select a Notarius ConfigKit overlay when extraction runs. This
|
||||||
# is independent of Narratio's selected overlay and may use a different name.
|
# is independent of Narratio's selected overlay and may use a different name.
|
||||||
# See docs/config.md and docs/integrations/notarius.md for the contracts.
|
# See docs/config.md and docs/integrations/notarius.md for the contracts.
|
||||||
# config_profile: downstream-economy
|
# config_overlay: downstream-economy
|
||||||
config_path: /usr/local/etc/notarius/config.yml
|
config_path: /usr/local/etc/notarius/config.yml
|
||||||
pipeline_id: dnd-session
|
pipeline_id: dnd-session
|
||||||
timeout: 3h
|
timeout: 3h
|
||||||
@@ -217,6 +217,9 @@ notarius:
|
|||||||
|
|
||||||
scriptorium:
|
scriptorium:
|
||||||
binary: scriptorium
|
binary: scriptorium
|
||||||
|
# Select provider names provisioned through Narratio's environment/secrets.
|
||||||
|
# Used for trim, analysis, and render-debug calls; no provider override.
|
||||||
|
# credentials: [OPENROUTER_API_KEY, RAKESTRAWHOME_API_KEY]
|
||||||
config_path: /usr/local/etc/scriptorium/config.yml
|
config_path: /usr/local/etc/scriptorium/config.yml
|
||||||
timeout: 10m
|
timeout: 10m
|
||||||
render_debug: false
|
render_debug: false
|
||||||
|
|||||||
@@ -68,6 +68,7 @@ normalize:
|
|||||||
|
|
||||||
scriptorium:
|
scriptorium:
|
||||||
binary: scriptorium
|
binary: scriptorium
|
||||||
|
# credentials: [OPENROUTER_API_KEY] # Enable when this provider is configured.
|
||||||
config_path: /usr/local/etc/scriptorium/config.yml
|
config_path: /usr/local/etc/scriptorium/config.yml
|
||||||
timeout: 10m
|
timeout: 10m
|
||||||
render_debug: false
|
render_debug: false
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
scriptorium:
|
|
||||||
artifact_families:
|
|
||||||
character_items:
|
character_items:
|
||||||
enabled: true
|
enabled: true
|
||||||
for_each: party.characters
|
for_each: party.characters
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
scriptorium:
|
|
||||||
artifact_families:
|
|
||||||
character_meta:
|
character_meta:
|
||||||
enabled: true
|
enabled: true
|
||||||
for_each: party.characters
|
for_each: party.characters
|
||||||
|
|||||||
@@ -1,6 +1,3 @@
|
|||||||
scriptorium:
|
|
||||||
artifacts:
|
|
||||||
player_handout:
|
|
||||||
enabled: true
|
enabled: true
|
||||||
prompt_id: dnd.player_handout
|
prompt_id: dnd.player_handout
|
||||||
profile_id: production-placeholder
|
profile_id: production-placeholder
|
||||||
|
|||||||
@@ -1,6 +1,3 @@
|
|||||||
scriptorium:
|
|
||||||
artifacts:
|
|
||||||
session_recap:
|
|
||||||
enabled: true
|
enabled: true
|
||||||
prompt_id: dnd.session_recap
|
prompt_id: dnd.session_recap
|
||||||
profile_id: production-placeholder
|
profile_id: production-placeholder
|
||||||
|
|||||||
@@ -1,3 +1,15 @@
|
|||||||
|
config:
|
||||||
|
sequences:
|
||||||
|
- destination: [publish, outputs]
|
||||||
|
key: source
|
||||||
|
mode: upsert
|
||||||
|
|
||||||
|
publish:
|
||||||
|
outputs:
|
||||||
|
- source: narratio.transcript.final_markdown
|
||||||
|
dest: transcripts/final.md
|
||||||
|
required: false
|
||||||
|
|
||||||
audita:
|
audita:
|
||||||
proposal_profile: narratio-testing-model-placeholder
|
proposal_profile: narratio-testing-model-placeholder
|
||||||
validation_profile: narratio-testing-validator-placeholder
|
validation_profile: narratio-testing-validator-placeholder
|
||||||
@@ -9,6 +21,7 @@ scriptorium:
|
|||||||
player_handout:
|
player_handout:
|
||||||
profile_id: testing-placeholder
|
profile_id: testing-placeholder
|
||||||
testing_notes:
|
testing_notes:
|
||||||
|
extends: session_recap
|
||||||
enabled: false
|
enabled: false
|
||||||
output_path: artifacts/testing-notes.md
|
output_path: artifacts/testing-notes.md
|
||||||
artifact_families:
|
artifact_families:
|
||||||
|
|||||||
@@ -1,13 +1,25 @@
|
|||||||
# Copyable production-base/testing-overlay entry point. ConfigKit expands only
|
# ConfigKit assembles these declared sources; destinations define artifact IDs.
|
||||||
# these explicit path and glob imports; Narratio never scans directories itself.
|
config:
|
||||||
configkit:
|
|
||||||
imports:
|
imports:
|
||||||
- path: conf.d/platform.yml
|
- path: conf.d/platform.yml
|
||||||
|
required: true
|
||||||
- path: conf.d/storage.yml
|
- path: conf.d/storage.yml
|
||||||
|
required: true
|
||||||
- path: conf.d/transcript.yml
|
- path: conf.d/transcript.yml
|
||||||
|
required: true
|
||||||
- path: conf.d/publish.yml
|
- path: conf.d/publish.yml
|
||||||
- glob: artifacts/*.yml
|
required: true
|
||||||
- glob: artifact-families/*.yml
|
- path: conf.d/local.yml
|
||||||
|
- path: artifacts/session_recap.yml
|
||||||
|
destination: [scriptorium, artifacts, session_recap]
|
||||||
|
required: true
|
||||||
|
- path: artifacts/player_handout.yml
|
||||||
|
destination: [scriptorium, artifacts, player_handout]
|
||||||
|
required: true
|
||||||
|
- dir: artifact-families
|
||||||
|
pattern: "*.yml"
|
||||||
|
destination: [scriptorium, artifact_families]
|
||||||
|
required: true
|
||||||
|
|
||||||
scriptorium:
|
scriptorium:
|
||||||
binary: scriptorium
|
binary: scriptorium
|
||||||
|
|||||||
2
examples/session-inputs/local-audio.yml
Normal file
2
examples/session-inputs/local-audio.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
inputs:
|
||||||
|
audio_dir: ../audio
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: session-inputs/local-audio.yml
|
||||||
|
required: true
|
||||||
session_id: 2026-05-03
|
session_id: 2026-05-03
|
||||||
date: 2026-05-03
|
date: 2026-05-03
|
||||||
title: Sample Session
|
title: Sample Session
|
||||||
inputs:
|
|
||||||
audio_dir: ./audio
|
|
||||||
|
|||||||
6
go.mod
6
go.mod
@@ -1,14 +1,14 @@
|
|||||||
module gitea.maximumdirect.net/eric/narratio
|
module gitea.maximumdirect.net/eric/narratio
|
||||||
|
|
||||||
go 1.26.0
|
go 1.27.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
gitea.maximumdirect.net/eric/ConfigKit v0.4.0
|
|
||||||
github.com/aws/aws-sdk-go-v2/config v1.32.17
|
github.com/aws/aws-sdk-go-v2/config v1.32.17
|
||||||
github.com/aws/aws-sdk-go-v2/credentials v1.19.16
|
github.com/aws/aws-sdk-go-v2/credentials v1.19.16
|
||||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.101.0
|
github.com/aws/aws-sdk-go-v2/service/s3 v1.101.0
|
||||||
github.com/aws/smithy-go v1.25.1
|
github.com/aws/smithy-go v1.25.1
|
||||||
github.com/google/go-cmp v0.7.0
|
github.com/google/go-cmp v0.7.0
|
||||||
|
go.maximumdirect.net/configkit v1.2.1
|
||||||
golang.org/x/sync v0.22.0
|
golang.org/x/sync v0.22.0
|
||||||
golang.org/x/sys v0.47.0
|
golang.org/x/sys v0.47.0
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
@@ -29,5 +29,5 @@ require (
|
|||||||
github.com/aws/aws-sdk-go-v2/service/sso v1.30.17 // indirect
|
github.com/aws/aws-sdk-go-v2/service/sso v1.30.17 // indirect
|
||||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.35.21 // indirect
|
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.35.21 // indirect
|
||||||
github.com/aws/aws-sdk-go-v2/service/sts v1.42.1 // indirect
|
github.com/aws/aws-sdk-go-v2/service/sts v1.42.1 // indirect
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6 // indirect
|
go.yaml.in/yaml/v4 v4.0.0 // indirect
|
||||||
)
|
)
|
||||||
|
|||||||
8
go.sum
8
go.sum
@@ -1,5 +1,3 @@
|
|||||||
gitea.maximumdirect.net/eric/ConfigKit v0.4.0 h1:fo+vKff3zTGeWqJIA38NtT84b6OUP//9ZmBH3lFuKgk=
|
|
||||||
gitea.maximumdirect.net/eric/ConfigKit v0.4.0/go.mod h1:tYWpsrbLyu05r8+1MapWp5fN6ZrX9I8hU2xEPedYmYk=
|
|
||||||
github.com/aws/aws-sdk-go-v2 v1.41.7 h1:DWpAJt66FmnnaRIOT/8ASTucrvuDPZASqhhLey6tLY8=
|
github.com/aws/aws-sdk-go-v2 v1.41.7 h1:DWpAJt66FmnnaRIOT/8ASTucrvuDPZASqhhLey6tLY8=
|
||||||
github.com/aws/aws-sdk-go-v2 v1.41.7/go.mod h1:4LAfZOPHNVNQEckOACQx60Y8pSRjIkNZQz1w92xpMJc=
|
github.com/aws/aws-sdk-go-v2 v1.41.7/go.mod h1:4LAfZOPHNVNQEckOACQx60Y8pSRjIkNZQz1w92xpMJc=
|
||||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.10 h1:gx1AwW1Iyk9Z9dD9F4akX5gnN3QZwUB20GGKH/I+Rho=
|
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.10 h1:gx1AwW1Iyk9Z9dD9F4akX5gnN3QZwUB20GGKH/I+Rho=
|
||||||
@@ -38,8 +36,10 @@ github.com/aws/smithy-go v1.25.1 h1:J8ERsGSU7d+aCmdQur5Txg6bVoYelvQJgtZehD12GkI=
|
|||||||
github.com/aws/smithy-go v1.25.1/go.mod h1:YE2RhdIuDbA5E5bTdciG9KrW3+TiEONeUWCqxX9i1Fc=
|
github.com/aws/smithy-go v1.25.1/go.mod h1:YE2RhdIuDbA5E5bTdciG9KrW3+TiEONeUWCqxX9i1Fc=
|
||||||
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
||||||
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
go.maximumdirect.net/configkit v1.2.1 h1:f+/6WjNl6CULbMr6ZSVwi4aty9rmuDfJlvpeU7I+HZM=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
go.maximumdirect.net/configkit v1.2.1/go.mod h1:ewu6blSokUDCMovy8JBXAdXRikGmlHXAQpFghnPWRfs=
|
||||||
|
go.yaml.in/yaml/v4 v4.0.0 h1:/LG1pNO84Z4l603j/xMn69CcS5OYhMQ/f7l2LoQUGuw=
|
||||||
|
go.yaml.in/yaml/v4 v4.0.0/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
||||||
golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek=
|
golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek=
|
||||||
golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
||||||
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
|
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/adapters/subprocess"
|
"gitea.maximumdirect.net/eric/narratio/internal/adapters/subprocess"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/fileops"
|
"gitea.maximumdirect.net/eric/narratio/internal/fileops"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/adapters/subprocess"
|
"gitea.maximumdirect.net/eric/narratio/internal/adapters/subprocess"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ package notarius
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
// FakeRunner is a configurable in-memory runner for stage tests.
|
// FakeRunner is a configurable in-memory runner for stage tests.
|
||||||
@@ -20,9 +20,9 @@ func (f *FakeRunner) Run(ctx context.Context, req RunRequest) (RunResult, error)
|
|||||||
}
|
}
|
||||||
copyRequest := req
|
copyRequest := req
|
||||||
copyRequest.Credentials = append([]configkit.Secret(nil), req.Credentials...)
|
copyRequest.Credentials = append([]configkit.Secret(nil), req.Credentials...)
|
||||||
if req.ConfigProfile != nil {
|
if req.ConfigOverlay != nil {
|
||||||
profile := *req.ConfigProfile
|
profile := *req.ConfigOverlay
|
||||||
copyRequest.ConfigProfile = &profile
|
copyRequest.ConfigOverlay = &profile
|
||||||
}
|
}
|
||||||
copyRequest.References = append([]ReferenceBinding(nil), req.References...)
|
copyRequest.References = append([]ReferenceBinding(nil), req.References...)
|
||||||
f.Requests = append(f.Requests, copyRequest)
|
f.Requests = append(f.Requests, copyRequest)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
const ReceiptSchemaVersion = "notarius.run-result.v2"
|
const ReceiptSchemaVersion = "notarius.run-result.v2"
|
||||||
@@ -27,7 +27,7 @@ type RunRequest struct {
|
|||||||
Binary string
|
Binary string
|
||||||
// Credentials are already-resolved environment references selected for Notarius.
|
// Credentials are already-resolved environment references selected for Notarius.
|
||||||
Credentials []configkit.Secret
|
Credentials []configkit.Secret
|
||||||
ConfigProfile *string
|
ConfigOverlay *string
|
||||||
ConfigPath string
|
ConfigPath string
|
||||||
PipelineID string
|
PipelineID string
|
||||||
InputPath string
|
InputPath string
|
||||||
|
|||||||
@@ -72,8 +72,8 @@ func (r *SubprocessRunner) Run(ctx context.Context, req RunRequest) (RunResult,
|
|||||||
for _, reference := range references {
|
for _, reference := range references {
|
||||||
args = append(args, "--reference", reference.Selector+"="+reference.Path)
|
args = append(args, "--reference", reference.Selector+"="+reference.Path)
|
||||||
}
|
}
|
||||||
if req.ConfigProfile != nil {
|
if req.ConfigOverlay != nil {
|
||||||
args = append(args, "--config-profile", *req.ConfigProfile)
|
args = append(args, "--config-overlay", *req.ConfigOverlay)
|
||||||
}
|
}
|
||||||
args = append(args, "--json")
|
args = append(args, "--json")
|
||||||
processResult, err := r.run(ctx, subprocess.RunRequest{
|
processResult, err := r.run(ctx, subprocess.RunRequest{
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
sharedsubprocess "gitea.maximumdirect.net/eric/narratio/internal/adapters/subprocess"
|
sharedsubprocess "gitea.maximumdirect.net/eric/narratio/internal/adapters/subprocess"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ func TestSubprocessRunnerMapsCacheControlsToArguments(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSubprocessRunnerMapsConfigProfileToArgumentPair(t *testing.T) {
|
func TestSubprocessRunnerMapsConfigOverlayToArgumentPair(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
supplied bool
|
supplied bool
|
||||||
@@ -133,7 +133,7 @@ func TestSubprocessRunnerMapsConfigProfileToArgumentPair(t *testing.T) {
|
|||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
req := validRunRequest(t)
|
req := validRunRequest(t)
|
||||||
if test.supplied {
|
if test.supplied {
|
||||||
req.ConfigProfile = &test.value
|
req.ConfigOverlay = &test.value
|
||||||
}
|
}
|
||||||
var captured sharedsubprocess.RunRequest
|
var captured sharedsubprocess.RunRequest
|
||||||
runner := &SubprocessRunner{run: func(_ context.Context, processReq sharedsubprocess.RunRequest) (sharedsubprocess.RunResult, error) {
|
runner := &SubprocessRunner{run: func(_ context.Context, processReq sharedsubprocess.RunRequest) (sharedsubprocess.RunResult, error) {
|
||||||
@@ -147,19 +147,19 @@ func TestSubprocessRunnerMapsConfigProfileToArgumentPair(t *testing.T) {
|
|||||||
}
|
}
|
||||||
flagIndex := -1
|
flagIndex := -1
|
||||||
for index, arg := range captured.Args {
|
for index, arg := range captured.Args {
|
||||||
if arg == "--config-profile" {
|
if arg == "--config-overlay" {
|
||||||
flagIndex = index
|
flagIndex = index
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !test.supplied {
|
if !test.supplied {
|
||||||
if flagIndex >= 0 {
|
if flagIndex >= 0 {
|
||||||
t.Fatalf("subprocess args unexpectedly contain config profile: %#v", captured.Args)
|
t.Fatalf("subprocess args unexpectedly contain config overlay: %#v", captured.Args)
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if flagIndex < 0 || flagIndex+2 >= len(captured.Args) || captured.Args[flagIndex+1] != test.value || captured.Args[flagIndex+2] != "--json" {
|
if flagIndex < 0 || flagIndex+2 >= len(captured.Args) || captured.Args[flagIndex+1] != test.value || captured.Args[flagIndex+2] != "--json" {
|
||||||
t.Fatalf("config profile argument boundary = %#v, want flag, exact value, then --json", captured.Args)
|
t.Fatalf("config overlay argument boundary = %#v, want flag, exact value, then --json", captured.Args)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -455,7 +455,7 @@ func TestSubprocessRunnerReturnsProcessFailuresWithoutParsingStdout(t *testing.T
|
|||||||
req := validRunRequest(t)
|
req := validRunRequest(t)
|
||||||
if test.name == "nonzero" {
|
if test.name == "nonzero" {
|
||||||
profile := "missing-profile"
|
profile := "missing-profile"
|
||||||
req.ConfigProfile = &profile
|
req.ConfigOverlay = &profile
|
||||||
}
|
}
|
||||||
req.Binary = writeShellScript(t, "#!/bin/sh\n"+test.scriptBody)
|
req.Binary = writeShellScript(t, "#!/bin/sh\n"+test.scriptBody)
|
||||||
req.Timeout = test.timeout
|
req.Timeout = test.timeout
|
||||||
@@ -754,7 +754,7 @@ func TestLoadDiagnosticSummariesValidateBoundsAndTolerateUnknownFields(t *testin
|
|||||||
|
|
||||||
func TestFakeRunnerCapturesRequestsAndHonorsContextAndError(t *testing.T) {
|
func TestFakeRunnerCapturesRequestsAndHonorsContextAndError(t *testing.T) {
|
||||||
profile := "testing"
|
profile := "testing"
|
||||||
req := RunRequest{PipelineID: "pipeline", ConfigProfile: &profile, References: []ReferenceBinding{{Selector: "party", Path: "/references/party.json"}}}
|
req := RunRequest{PipelineID: "pipeline", ConfigOverlay: &profile, References: []ReferenceBinding{{Selector: "party", Path: "/references/party.json"}}}
|
||||||
want := RunResult{BundleRoot: "/bundle"}
|
want := RunResult{BundleRoot: "/bundle"}
|
||||||
fake := &FakeRunner{Result: want}
|
fake := &FakeRunner{Result: want}
|
||||||
got, err := fake.Run(context.Background(), req)
|
got, err := fake.Run(context.Background(), req)
|
||||||
@@ -766,8 +766,8 @@ func TestFakeRunnerCapturesRequestsAndHonorsContextAndError(t *testing.T) {
|
|||||||
t.Fatalf("fake retained aliased request references: %#v", fake.Requests[0].References)
|
t.Fatalf("fake retained aliased request references: %#v", fake.Requests[0].References)
|
||||||
}
|
}
|
||||||
profile = "changed"
|
profile = "changed"
|
||||||
if *fake.Requests[0].ConfigProfile != "testing" {
|
if *fake.Requests[0].ConfigOverlay != "testing" {
|
||||||
t.Fatalf("fake retained aliased config profile: %q", *fake.Requests[0].ConfigProfile)
|
t.Fatalf("fake retained aliased config overlay: %q", *fake.Requests[0].ConfigOverlay)
|
||||||
}
|
}
|
||||||
|
|
||||||
wantErr := errors.New("configured failure")
|
wantErr := errors.New("configured failure")
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package scriptorium
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/fileops"
|
"gitea.maximumdirect.net/eric/narratio/internal/fileops"
|
||||||
)
|
)
|
||||||
@@ -65,6 +66,7 @@ func (f *FakeRunner) RunArtifact(ctx context.Context, req RunArtifactRequest) (A
|
|||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return ArtifactResult{}, err
|
return ArtifactResult{}, err
|
||||||
}
|
}
|
||||||
|
req.Credentials = slices.Clone(req.Credentials)
|
||||||
f.RunRequests = append(f.RunRequests, req)
|
f.RunRequests = append(f.RunRequests, req)
|
||||||
if f.RunErr != nil {
|
if f.RunErr != nil {
|
||||||
return ArtifactResult{}, f.RunErr
|
return ArtifactResult{}, f.RunErr
|
||||||
@@ -105,6 +107,7 @@ func (f *FakeRunner) RenderArtifact(ctx context.Context, req RenderArtifactReque
|
|||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return ArtifactResult{}, err
|
return ArtifactResult{}, err
|
||||||
}
|
}
|
||||||
|
req.Credentials = slices.Clone(req.Credentials)
|
||||||
f.RenderRequests = append(f.RenderRequests, req)
|
f.RenderRequests = append(f.RenderRequests, req)
|
||||||
if f.RenderErr != nil {
|
if f.RenderErr != nil {
|
||||||
return ArtifactResult{}, f.RenderErr
|
return ArtifactResult{}, f.RenderErr
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ package scriptorium
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -32,7 +34,7 @@ type RunArtifactRequest struct {
|
|||||||
StderrLogPath string
|
StderrLogPath string
|
||||||
GeneratedConfigPath string
|
GeneratedConfigPath string
|
||||||
Timeout time.Duration
|
Timeout time.Duration
|
||||||
APIKeyEnv string
|
Credentials []configkit.Secret
|
||||||
WorkingDir string
|
WorkingDir string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -49,7 +51,7 @@ type RenderArtifactRequest struct {
|
|||||||
StderrLogPath string
|
StderrLogPath string
|
||||||
GeneratedConfigPath string
|
GeneratedConfigPath string
|
||||||
Timeout time.Duration
|
Timeout time.Duration
|
||||||
APIKeyEnv string
|
Credentials []configkit.Secret
|
||||||
WorkingDir string
|
WorkingDir string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,12 @@ func (r *SubprocessRunner) RunArtifact(ctx context.Context, req RunArtifactReque
|
|||||||
if r == nil {
|
if r == nil {
|
||||||
return ArtifactResult{}, fmt.Errorf("scriptorium subprocess runner is nil")
|
return ArtifactResult{}, fmt.Errorf("scriptorium subprocess runner is nil")
|
||||||
}
|
}
|
||||||
credentialPresent, err := validateCommonRunRequest(req.Binary, req.ConfigPath, req.PromptID, req.OutputPath, req.Timeout, req.APIKeyEnv, req.InputPaths, req.Vars)
|
err := validateCommonRunRequest(req.Binary, req.ConfigPath, req.PromptID, req.OutputPath, req.Timeout, req.InputPaths, req.Vars)
|
||||||
|
if err != nil {
|
||||||
|
return ArtifactResult{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
envOverrides, sensitiveNames, err := subprocess.CredentialEnvironment(req.Credentials)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ArtifactResult{}, err
|
return ArtifactResult{}, err
|
||||||
}
|
}
|
||||||
@@ -46,8 +51,7 @@ func (r *SubprocessRunner) RunArtifact(ctx context.Context, req RunArtifactReque
|
|||||||
InputPaths: cloneStringMap(req.InputPaths),
|
InputPaths: cloneStringMap(req.InputPaths),
|
||||||
Vars: cloneStringMap(req.Vars),
|
Vars: cloneStringMap(req.Vars),
|
||||||
OutputPath: req.OutputPath,
|
OutputPath: req.OutputPath,
|
||||||
APIKeyEnv: strings.TrimSpace(req.APIKeyEnv),
|
CredentialNames: sensitiveNames,
|
||||||
APIKeyEnvPresent: credentialPresent,
|
|
||||||
WorkingDir: req.WorkingDir,
|
WorkingDir: req.WorkingDir,
|
||||||
RenderFormat: "",
|
RenderFormat: "",
|
||||||
RenderPromptStore: false,
|
RenderPromptStore: false,
|
||||||
@@ -56,7 +60,6 @@ func (r *SubprocessRunner) RunArtifact(ctx context.Context, req RunArtifactReque
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
envOverrides, sensitiveNames := credentialEnvironment(req.APIKeyEnv)
|
|
||||||
runRes, runErr := subprocess.Run(ctx, subprocess.RunRequest{
|
runRes, runErr := subprocess.Run(ctx, subprocess.RunRequest{
|
||||||
Executable: req.Binary,
|
Executable: req.Binary,
|
||||||
Args: args,
|
Args: args,
|
||||||
@@ -84,8 +87,7 @@ func (r *SubprocessRunner) RunArtifact(ctx context.Context, req RunArtifactReque
|
|||||||
"config_path": strings.TrimSpace(req.ConfigPath),
|
"config_path": strings.TrimSpace(req.ConfigPath),
|
||||||
"inputs_count": len(req.InputPaths),
|
"inputs_count": len(req.InputPaths),
|
||||||
"vars_count": len(req.Vars),
|
"vars_count": len(req.Vars),
|
||||||
"api_key_env": strings.TrimSpace(req.APIKeyEnv),
|
"credential_env_names": sensitiveNames,
|
||||||
"api_key_env_present": credentialPresent,
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -114,7 +116,12 @@ func (r *SubprocessRunner) RenderArtifact(ctx context.Context, req RenderArtifac
|
|||||||
if r == nil {
|
if r == nil {
|
||||||
return ArtifactResult{}, fmt.Errorf("scriptorium subprocess runner is nil")
|
return ArtifactResult{}, fmt.Errorf("scriptorium subprocess runner is nil")
|
||||||
}
|
}
|
||||||
credentialPresent, err := validateCommonRunRequest(req.Binary, req.ConfigPath, req.PromptID, req.OutputPath, req.Timeout, req.APIKeyEnv, req.InputPaths, req.Vars)
|
err := validateCommonRunRequest(req.Binary, req.ConfigPath, req.PromptID, req.OutputPath, req.Timeout, req.InputPaths, req.Vars)
|
||||||
|
if err != nil {
|
||||||
|
return ArtifactResult{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
envOverrides, sensitiveNames, err := subprocess.CredentialEnvironment(req.Credentials)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ArtifactResult{}, err
|
return ArtifactResult{}, err
|
||||||
}
|
}
|
||||||
@@ -132,8 +139,7 @@ func (r *SubprocessRunner) RenderArtifact(ctx context.Context, req RenderArtifac
|
|||||||
InputPaths: cloneStringMap(req.InputPaths),
|
InputPaths: cloneStringMap(req.InputPaths),
|
||||||
Vars: cloneStringMap(req.Vars),
|
Vars: cloneStringMap(req.Vars),
|
||||||
OutputPath: req.OutputPath,
|
OutputPath: req.OutputPath,
|
||||||
APIKeyEnv: strings.TrimSpace(req.APIKeyEnv),
|
CredentialNames: sensitiveNames,
|
||||||
APIKeyEnvPresent: credentialPresent,
|
|
||||||
WorkingDir: req.WorkingDir,
|
WorkingDir: req.WorkingDir,
|
||||||
RenderFormat: "json",
|
RenderFormat: "json",
|
||||||
RenderPromptStore: false,
|
RenderPromptStore: false,
|
||||||
@@ -142,7 +148,6 @@ func (r *SubprocessRunner) RenderArtifact(ctx context.Context, req RenderArtifac
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
envOverrides, sensitiveNames := credentialEnvironment(req.APIKeyEnv)
|
|
||||||
runRes, runErr := subprocess.Run(ctx, subprocess.RunRequest{
|
runRes, runErr := subprocess.Run(ctx, subprocess.RunRequest{
|
||||||
Executable: req.Binary,
|
Executable: req.Binary,
|
||||||
Args: args,
|
Args: args,
|
||||||
@@ -170,8 +175,7 @@ func (r *SubprocessRunner) RenderArtifact(ctx context.Context, req RenderArtifac
|
|||||||
"config_path": strings.TrimSpace(req.ConfigPath),
|
"config_path": strings.TrimSpace(req.ConfigPath),
|
||||||
"inputs_count": len(req.InputPaths),
|
"inputs_count": len(req.InputPaths),
|
||||||
"vars_count": len(req.Vars),
|
"vars_count": len(req.Vars),
|
||||||
"api_key_env": strings.TrimSpace(req.APIKeyEnv),
|
"credential_env_names": sensitiveNames,
|
||||||
"api_key_env_present": credentialPresent,
|
|
||||||
"format": "json",
|
"format": "json",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -191,57 +195,39 @@ func validateCommonRunRequest(
|
|||||||
promptID string,
|
promptID string,
|
||||||
outputPath string,
|
outputPath string,
|
||||||
timeout time.Duration,
|
timeout time.Duration,
|
||||||
apiKeyEnv string,
|
|
||||||
inputPaths map[string]string,
|
inputPaths map[string]string,
|
||||||
vars map[string]string,
|
vars map[string]string,
|
||||||
) (bool, error) {
|
) error {
|
||||||
if strings.TrimSpace(binary) == "" {
|
if strings.TrimSpace(binary) == "" {
|
||||||
return false, fmt.Errorf("scriptorium binary is required")
|
return fmt.Errorf("scriptorium binary is required")
|
||||||
}
|
}
|
||||||
if strings.TrimSpace(configPath) == "" && configPath != "" {
|
if strings.TrimSpace(configPath) == "" && configPath != "" {
|
||||||
return false, fmt.Errorf("scriptorium config path must be non-empty when provided")
|
return fmt.Errorf("scriptorium config path must be non-empty when provided")
|
||||||
}
|
}
|
||||||
if strings.TrimSpace(promptID) == "" {
|
if strings.TrimSpace(promptID) == "" {
|
||||||
return false, fmt.Errorf("scriptorium prompt id is required")
|
return fmt.Errorf("scriptorium prompt id is required")
|
||||||
}
|
}
|
||||||
if strings.TrimSpace(outputPath) == "" {
|
if strings.TrimSpace(outputPath) == "" {
|
||||||
return false, fmt.Errorf("scriptorium output path is required")
|
return fmt.Errorf("scriptorium output path is required")
|
||||||
}
|
}
|
||||||
if timeout <= 0 {
|
if timeout <= 0 {
|
||||||
return false, fmt.Errorf("scriptorium timeout must be > 0")
|
return fmt.Errorf("scriptorium timeout must be > 0")
|
||||||
}
|
}
|
||||||
for name, path := range inputPaths {
|
for name, path := range inputPaths {
|
||||||
if strings.TrimSpace(name) == "" {
|
if strings.TrimSpace(name) == "" {
|
||||||
return false, fmt.Errorf("scriptorium input names must be non-empty")
|
return fmt.Errorf("scriptorium input names must be non-empty")
|
||||||
}
|
}
|
||||||
if strings.TrimSpace(path) == "" {
|
if strings.TrimSpace(path) == "" {
|
||||||
return false, fmt.Errorf("scriptorium input %q path is required", name)
|
return fmt.Errorf("scriptorium input %q path is required", name)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for name := range vars {
|
for name := range vars {
|
||||||
if strings.TrimSpace(name) == "" {
|
if strings.TrimSpace(name) == "" {
|
||||||
return false, fmt.Errorf("scriptorium variable names must be non-empty")
|
return fmt.Errorf("scriptorium variable names must be non-empty")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
trimmedEnv := strings.TrimSpace(apiKeyEnv)
|
return nil
|
||||||
if trimmedEnv == "" {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
value, ok := os.LookupEnv(trimmedEnv)
|
|
||||||
if !ok || strings.TrimSpace(value) == "" {
|
|
||||||
return false, fmt.Errorf("scriptorium required credential environment variable %s is not set", trimmedEnv)
|
|
||||||
}
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func credentialEnvironment(apiKeyEnv string) (map[string]string, []string) {
|
|
||||||
name := strings.TrimSpace(apiKeyEnv)
|
|
||||||
if name == "" {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
value, _ := os.LookupEnv(name)
|
|
||||||
return map[string]string{name: value}, []string{name}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func buildRunArgs(req RunArtifactRequest) []string {
|
func buildRunArgs(req RunArtifactRequest) []string {
|
||||||
@@ -258,9 +244,6 @@ func buildRunArgs(req RunArtifactRequest) []string {
|
|||||||
for _, kv := range sortedKeyValues(req.Vars) {
|
for _, kv := range sortedKeyValues(req.Vars) {
|
||||||
args = append(args, "--var", kv)
|
args = append(args, "--var", kv)
|
||||||
}
|
}
|
||||||
if envName := strings.TrimSpace(req.APIKeyEnv); envName != "" {
|
|
||||||
args = append(args, "--api-key-env", envName)
|
|
||||||
}
|
|
||||||
args = append(args, "--timeout", req.Timeout.String())
|
args = append(args, "--timeout", req.Timeout.String())
|
||||||
args = append(args, "--out", req.OutputPath)
|
args = append(args, "--out", req.OutputPath)
|
||||||
return args
|
return args
|
||||||
@@ -280,9 +263,6 @@ func buildRenderArgs(req RenderArtifactRequest) []string {
|
|||||||
for _, kv := range sortedKeyValues(req.Vars) {
|
for _, kv := range sortedKeyValues(req.Vars) {
|
||||||
args = append(args, "--var", kv)
|
args = append(args, "--var", kv)
|
||||||
}
|
}
|
||||||
if envName := strings.TrimSpace(req.APIKeyEnv); envName != "" {
|
|
||||||
args = append(args, "--api-key-env", envName)
|
|
||||||
}
|
|
||||||
args = append(args, "--timeout", req.Timeout.String())
|
args = append(args, "--timeout", req.Timeout.String())
|
||||||
args = append(args, "--format", "json")
|
args = append(args, "--format", "json")
|
||||||
args = append(args, "--out", req.OutputPath)
|
args = append(args, "--out", req.OutputPath)
|
||||||
@@ -316,8 +296,7 @@ type invocationPayload struct {
|
|||||||
InputPaths map[string]string
|
InputPaths map[string]string
|
||||||
Vars map[string]string
|
Vars map[string]string
|
||||||
OutputPath string
|
OutputPath string
|
||||||
APIKeyEnv string
|
CredentialNames []string
|
||||||
APIKeyEnvPresent bool
|
|
||||||
WorkingDir string
|
WorkingDir string
|
||||||
RenderFormat string
|
RenderFormat string
|
||||||
RenderPromptStore bool
|
RenderPromptStore bool
|
||||||
@@ -336,8 +315,7 @@ func writeInvocationConfig(path string, payload invocationPayload) error {
|
|||||||
"input_paths": payload.InputPaths,
|
"input_paths": payload.InputPaths,
|
||||||
"vars": payload.Vars,
|
"vars": payload.Vars,
|
||||||
"output_path": payload.OutputPath,
|
"output_path": payload.OutputPath,
|
||||||
"api_key_env": payload.APIKeyEnv,
|
"credential_env_names": payload.CredentialNames,
|
||||||
"api_key_env_present": payload.APIKeyEnvPresent,
|
|
||||||
"working_dir": payload.WorkingDir,
|
"working_dir": payload.WorkingDir,
|
||||||
"render_format": payload.RenderFormat,
|
"render_format": payload.RenderFormat,
|
||||||
"render_prompt_logged": payload.RenderPromptStore,
|
"render_prompt_logged": payload.RenderPromptStore,
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestSubprocessRunnerRunSuccessBuildsDeterministicArgsAndCapturesLogs(t *testing.T) {
|
func TestSubprocessRunnerRunSuccessBuildsDeterministicArgsAndCapturesLogs(t *testing.T) {
|
||||||
@@ -16,6 +18,13 @@ func TestSubprocessRunnerRunSuccessBuildsDeterministicArgsAndCapturesLogs(t *tes
|
|||||||
t.Setenv("GO_WANT_SCRIPTORIUM_HELPER", "1")
|
t.Setenv("GO_WANT_SCRIPTORIUM_HELPER", "1")
|
||||||
t.Setenv("SCRIPTORIUM_HELPER_MODE", "run_success")
|
t.Setenv("SCRIPTORIUM_HELPER_MODE", "run_success")
|
||||||
t.Setenv("OPENAI_KEY_SOURCE", "super-secret")
|
t.Setenv("OPENAI_KEY_SOURCE", "super-secret")
|
||||||
|
loaded, err := configkit.Load[struct {
|
||||||
|
Credentials []configkit.Secret `yaml:"credentials"`
|
||||||
|
}](configkit.Bytes("test.yml", []byte("credentials: [OPENAI_KEY_SOURCE]\n")))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Setenv("OPENAI_KEY_SOURCE", "changed-after-load")
|
||||||
recordPath := filepath.Join(t.TempDir(), "record.json")
|
recordPath := filepath.Join(t.TempDir(), "record.json")
|
||||||
t.Setenv("SCRIPTORIUM_HELPER_RECORD_PATH", recordPath)
|
t.Setenv("SCRIPTORIUM_HELPER_RECORD_PATH", recordPath)
|
||||||
|
|
||||||
@@ -34,7 +43,7 @@ func TestSubprocessRunnerRunSuccessBuildsDeterministicArgsAndCapturesLogs(t *tes
|
|||||||
StderrLogPath: filepath.Join(dir, "logs", "scriptorium.run.stderr.log"),
|
StderrLogPath: filepath.Join(dir, "logs", "scriptorium.run.stderr.log"),
|
||||||
GeneratedConfigPath: filepath.Join(dir, "config", "scriptorium.run.generated.yml"),
|
GeneratedConfigPath: filepath.Join(dir, "config", "scriptorium.run.generated.yml"),
|
||||||
Timeout: mustParseScriptoriumDuration(t, "2s"),
|
Timeout: mustParseScriptoriumDuration(t, "2s"),
|
||||||
APIKeyEnv: "OPENAI_KEY_SOURCE",
|
Credentials: loaded.Config.Credentials,
|
||||||
}
|
}
|
||||||
writeScriptoriumFile(t, req.InputPaths["transcript"], `{"segments":[]}`)
|
writeScriptoriumFile(t, req.InputPaths["transcript"], `{"segments":[]}`)
|
||||||
writeScriptoriumFile(t, req.InputPaths["other"], "notes\n")
|
writeScriptoriumFile(t, req.InputPaths["other"], "notes\n")
|
||||||
@@ -70,7 +79,6 @@ func TestSubprocessRunnerRunSuccessBuildsDeterministicArgsAndCapturesLogs(t *tes
|
|||||||
"--input", "transcript=" + req.InputPaths["transcript"],
|
"--input", "transcript=" + req.InputPaths["transcript"],
|
||||||
"--var", "campaign_name=Icewind Dale",
|
"--var", "campaign_name=Icewind Dale",
|
||||||
"--var", "session_id=2026-05-03",
|
"--var", "session_id=2026-05-03",
|
||||||
"--api-key-env", "OPENAI_KEY_SOURCE",
|
|
||||||
"--timeout", "2s",
|
"--timeout", "2s",
|
||||||
"--out", req.OutputPath,
|
"--out", req.OutputPath,
|
||||||
}
|
}
|
||||||
@@ -94,13 +102,31 @@ func TestSubprocessRunnerRunExitCodeOneFails(t *testing.T) {
|
|||||||
t.Setenv("GO_WANT_SCRIPTORIUM_HELPER", "1")
|
t.Setenv("GO_WANT_SCRIPTORIUM_HELPER", "1")
|
||||||
t.Setenv("SCRIPTORIUM_HELPER_MODE", "fail_exit1")
|
t.Setenv("SCRIPTORIUM_HELPER_MODE", "fail_exit1")
|
||||||
t.Setenv("SCRIPTORIUM_HELPER_RECORD_PATH", filepath.Join(t.TempDir(), "record.json"))
|
t.Setenv("SCRIPTORIUM_HELPER_RECORD_PATH", filepath.Join(t.TempDir(), "record.json"))
|
||||||
|
t.Setenv("CUSTOM_PROVIDER_KEY", "synthetic-failure-secret")
|
||||||
|
loaded, loadErr := configkit.Load[struct {
|
||||||
|
Credentials []configkit.Secret `yaml:"credentials"`
|
||||||
|
}](configkit.Bytes("test.yml", []byte("credentials: [CUSTOM_PROVIDER_KEY]\n")))
|
||||||
|
if loadErr != nil {
|
||||||
|
t.Fatal(loadErr)
|
||||||
|
}
|
||||||
|
|
||||||
runner := NewSubprocessRunner()
|
runner := NewSubprocessRunner()
|
||||||
req := runReqForTest(t, writeScriptoriumHelperWrapper(t))
|
req := runReqForTest(t, writeScriptoriumHelperWrapper(t))
|
||||||
|
req.Credentials = loaded.Config.Credentials
|
||||||
res, err := runner.RunArtifact(context.Background(), req)
|
res, err := runner.RunArtifact(context.Background(), req)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("RunArtifact() error = nil, want non-nil")
|
t.Fatal("RunArtifact() error = nil, want non-nil")
|
||||||
}
|
}
|
||||||
|
if strings.Contains(err.Error(), "synthetic-failure-secret") {
|
||||||
|
t.Fatal("failure leaked credential")
|
||||||
|
}
|
||||||
|
data, readErr := os.ReadFile(req.StderrLogPath)
|
||||||
|
if readErr != nil {
|
||||||
|
t.Fatal(readErr)
|
||||||
|
}
|
||||||
|
if strings.Contains(string(data), "synthetic-failure-secret") || !strings.Contains(string(data), "<redacted>") {
|
||||||
|
t.Fatal("failure log did not redact selected credential")
|
||||||
|
}
|
||||||
if res.ExitCode != 1 {
|
if res.ExitCode != 1 {
|
||||||
t.Fatalf("ExitCode = %d, want 1", res.ExitCode)
|
t.Fatalf("ExitCode = %d, want 1", res.ExitCode)
|
||||||
}
|
}
|
||||||
@@ -245,6 +271,7 @@ func TestScriptoriumSubprocessHelper(t *testing.T) {
|
|||||||
os.Exit(0)
|
os.Exit(0)
|
||||||
case "fail_exit1":
|
case "fail_exit1":
|
||||||
_, _ = os.Stderr.WriteString("scriptorium helper failure\n")
|
_, _ = os.Stderr.WriteString("scriptorium helper failure\n")
|
||||||
|
_, _ = os.Stderr.WriteString(os.Getenv("CUSTOM_PROVIDER_KEY"))
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
case "fail_exit2_with_output":
|
case "fail_exit2_with_output":
|
||||||
writeScriptoriumHelperFile(outputPath, "validation failed artifact\n")
|
writeScriptoriumHelperFile(outputPath, "validation failed artifact\n")
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ import (
|
|||||||
"github.com/aws/aws-sdk-go-v2/service/s3/types"
|
"github.com/aws/aws-sdk-go-v2/service/s3/types"
|
||||||
"github.com/aws/smithy-go"
|
"github.com/aws/smithy-go"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ package subprocess
|
|||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
// CredentialEnvironment returns captured secret values and names for a child
|
// CredentialEnvironment returns captured secret values and names for a child
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestCredentialEnvironmentUsesCapturedReferences(t *testing.T) {
|
func TestCredentialEnvironmentUsesCapturedReferences(t *testing.T) {
|
||||||
|
|||||||
@@ -272,7 +272,7 @@ func TestExecuteAnalyzeRejectsPositionalArgsAndForceFlag(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestExecuteAnalyzeMissingConfigUsesRunStageLoadingPath(t *testing.T) {
|
func TestExecuteAnalyzeMissingConfigUsesRunStageLoadingPath(t *testing.T) {
|
||||||
deps, missingPath, executor := guardedMissingPipelineDiscovery(t)
|
deps, _, executor := guardedMissingPipelineDiscovery(t)
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
code := executeWithDependencies([]string{"analyze", "2026-05-03"}, &stdout, &stderr, deps, executor)
|
code := executeWithDependencies([]string{"analyze", "2026-05-03"}, &stdout, &stderr, deps, executor)
|
||||||
@@ -282,8 +282,7 @@ func TestExecuteAnalyzeMissingConfigUsesRunStageLoadingPath(t *testing.T) {
|
|||||||
if stdout.Len() != 0 {
|
if stdout.Len() != 0 {
|
||||||
t.Fatalf("stdout = %q, want empty", stdout.String())
|
t.Fatalf("stdout = %q, want empty", stdout.String())
|
||||||
}
|
}
|
||||||
if got := stderr.String(); !strings.Contains(got, "analyze: no pipeline config path provided") ||
|
if got := stderr.String(); !strings.Contains(got, "source.missing") {
|
||||||
!strings.Contains(got, "no default pipeline config found") || !strings.Contains(got, missingPath) {
|
|
||||||
t.Fatalf("stderr = %q, want pipeline discovery error", stderr.String())
|
t.Fatalf("stderr = %q, want pipeline discovery error", stderr.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -376,7 +375,7 @@ func TestExecutePublishUnknownArtifactFailsValidation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestExecutePublishMissingConfigUsesRunStageLoadingPath(t *testing.T) {
|
func TestExecutePublishMissingConfigUsesRunStageLoadingPath(t *testing.T) {
|
||||||
deps, missingPath, executor := guardedMissingPipelineDiscovery(t)
|
deps, _, executor := guardedMissingPipelineDiscovery(t)
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
code := executeWithDependencies([]string{"publish", "2026-05-03"}, &stdout, &stderr, deps, executor)
|
code := executeWithDependencies([]string{"publish", "2026-05-03"}, &stdout, &stderr, deps, executor)
|
||||||
@@ -386,8 +385,7 @@ func TestExecutePublishMissingConfigUsesRunStageLoadingPath(t *testing.T) {
|
|||||||
if stdout.Len() != 0 {
|
if stdout.Len() != 0 {
|
||||||
t.Fatalf("stdout = %q, want empty", stdout.String())
|
t.Fatalf("stdout = %q, want empty", stdout.String())
|
||||||
}
|
}
|
||||||
if got := stderr.String(); !strings.Contains(got, "publish: no pipeline config path provided") ||
|
if got := stderr.String(); !strings.Contains(got, "source.missing") {
|
||||||
!strings.Contains(got, "no default pipeline config found") || !strings.Contains(got, missingPath) {
|
|
||||||
t.Fatalf("stderr = %q, want pipeline discovery error", stderr.String())
|
t.Fatalf("stderr = %q, want pipeline discovery error", stderr.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -272,7 +272,7 @@ func TestAssembledSplitBundleCommandsUseOneEffectiveFamilyConfiguration(t *testi
|
|||||||
}, &diff); err != nil {
|
}, &diff); err != nil {
|
||||||
t.Fatalf("compare profiles: %v", err)
|
t.Fatalf("compare profiles: %v", err)
|
||||||
}
|
}
|
||||||
if !strings.Contains(diff.String(), "audita.proposal_profile") || !strings.Contains(diff.String(), "character_items_arannis.profile_id") {
|
if !strings.Contains(diff.String(), "/audita/proposal_profile") || !strings.Contains(diff.String(), "/character_items_arannis/profile_id") {
|
||||||
t.Fatalf("profile diff = %q, want proposal profile and expanded family changes", diff.String())
|
t.Fatalf("profile diff = %q, want proposal profile and expanded family changes", diff.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,16 +4,15 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"io"
|
"io"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/adapters/storage"
|
"gitea.maximumdirect.net/eric/narratio/internal/adapters/storage"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||||
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
type commandDependencies struct {
|
type commandDependencies struct {
|
||||||
diagnostics io.Writer
|
diagnostics io.Writer
|
||||||
resolvePipelineConfigPath func(string) (string, error)
|
pipelineSearch *configkit.Search
|
||||||
loadPipelineConfig func(string, config.PipelineLoadOptions) (*config.PipelineConfig, error)
|
loadPipelineConfig func(string, config.PipelineLoadOptions) (*config.PipelineConfig, error)
|
||||||
downloadObjectToTemp func(context.Context, storage.ObjectStore, string, string) (string, error)
|
|
||||||
loadSecretsDir func(string) (*configkit.SecretsReport, error)
|
loadSecretsDir func(string) (*configkit.SecretsReport, error)
|
||||||
secretsBootstrap *secretsBootstrap
|
secretsBootstrap *secretsBootstrap
|
||||||
newObjectStore func(context.Context, *config.Config) (storage.ObjectStore, error)
|
newObjectStore func(context.Context, *config.Config) (storage.ObjectStore, error)
|
||||||
@@ -26,17 +25,11 @@ func normalizeCommandDependencies(deps commandDependencies) commandDependencies
|
|||||||
if deps.diagnostics == nil {
|
if deps.diagnostics == nil {
|
||||||
deps.diagnostics = io.Discard
|
deps.diagnostics = io.Discard
|
||||||
}
|
}
|
||||||
if deps.resolvePipelineConfigPath == nil {
|
|
||||||
deps.resolvePipelineConfigPath = resolvePipelineConfigPath
|
|
||||||
}
|
|
||||||
if deps.loadPipelineConfig == nil {
|
if deps.loadPipelineConfig == nil {
|
||||||
deps.loadPipelineConfig = config.LoadPipelineWithOptions
|
deps.loadPipelineConfig = config.LoadPipelineWithOptions
|
||||||
}
|
}
|
||||||
if deps.downloadObjectToTemp == nil {
|
|
||||||
deps.downloadObjectToTemp = storage.DownloadObjectToTemp
|
|
||||||
}
|
|
||||||
if deps.loadSecretsDir == nil {
|
if deps.loadSecretsDir == nil {
|
||||||
deps.loadSecretsDir = configkit.LoadSecretsDir
|
deps.loadSecretsDir = configkit.LoadSecretsIntoEnvironment
|
||||||
}
|
}
|
||||||
if deps.secretsBootstrap == nil {
|
if deps.secretsBootstrap == nil {
|
||||||
deps.secretsBootstrap = &secretsBootstrap{}
|
deps.secretsBootstrap = &secretsBootstrap{}
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/artifacts"
|
"gitea.maximumdirect.net/eric/narratio/internal/artifacts"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/manifest"
|
"gitea.maximumdirect.net/eric/narratio/internal/manifest"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -70,7 +69,7 @@ func TestExecuteMissingRequiredFlags(t *testing.T) {
|
|||||||
{name: "resume removed", args: []string{"resume"}, want: `unknown command: "resume"`},
|
{name: "resume removed", args: []string{"resume"}, want: `unknown command: "resume"`},
|
||||||
{name: "run-stage missing name", args: []string{"run-stage", "--config", "a", "--session", "b"}, want: "run-stage: expected stage name and session_id"},
|
{name: "run-stage missing name", args: []string{"run-stage", "--config", "a", "--session", "b"}, want: "run-stage: expected stage name and session_id"},
|
||||||
{name: "run-stage missing session", args: []string{"run-stage", "polish"}, want: "run-stage: expected stage name and session_id"},
|
{name: "run-stage missing session", args: []string{"run-stage", "polish"}, want: "run-stage: expected stage name and session_id"},
|
||||||
{name: "run missing config uses defaults", args: []string{"run", "2026-05-03", "--session", "session.yml"}, want: "run: no pipeline config path provided", controlledDiscovery: true},
|
{name: "run missing config uses defaults", args: []string{"run", "2026-05-03", "--session", "session.yml"}, want: "source.missing", controlledDiscovery: true},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
@@ -80,9 +79,8 @@ func TestExecuteMissingRequiredFlags(t *testing.T) {
|
|||||||
|
|
||||||
deps := commandDependencies{}
|
deps := commandDependencies{}
|
||||||
executor := pipelineExecutor(executePlan)
|
executor := pipelineExecutor(executePlan)
|
||||||
missingPath := ""
|
|
||||||
if tc.controlledDiscovery {
|
if tc.controlledDiscovery {
|
||||||
deps, missingPath, executor = guardedMissingPipelineDiscovery(t)
|
deps, _, executor = guardedMissingPipelineDiscovery(t)
|
||||||
}
|
}
|
||||||
code := executeWithDependencies(tc.args, &stdout, &stderr, deps, executor)
|
code := executeWithDependencies(tc.args, &stdout, &stderr, deps, executor)
|
||||||
if code == 0 {
|
if code == 0 {
|
||||||
@@ -94,11 +92,7 @@ func TestExecuteMissingRequiredFlags(t *testing.T) {
|
|||||||
if !strings.Contains(stderr.String(), tc.want) {
|
if !strings.Contains(stderr.String(), tc.want) {
|
||||||
t.Fatalf("stderr = %q, want to contain %q", stderr.String(), tc.want)
|
t.Fatalf("stderr = %q, want to contain %q", stderr.String(), tc.want)
|
||||||
}
|
}
|
||||||
if tc.controlledDiscovery {
|
|
||||||
if got := stderr.String(); !strings.Contains(got, "no default pipeline config found") || !strings.Contains(got, missingPath) {
|
|
||||||
t.Fatalf("stderr = %q, want controlled searched path %q", got, missingPath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -267,7 +261,7 @@ inputs:
|
|||||||
|
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
code := Execute([]string{"run-stage", "polish", sessionID, "--config", pipelinePath, "--campaign-file", campaignPath, "--session", sessionPath, "--force"}, &stdout, &stderr)
|
code := Execute([]string{"run-stage", "polish", sessionID, "--config", pipelinePath, "--campaign-file", campaignPath, "--session", sessionPath, "--force", "--secrets-dir", secretsDir}, &stdout, &stderr)
|
||||||
if code != 0 {
|
if code != 0 {
|
||||||
t.Fatalf("exit code = %d, want 0; stderr=%q", code, stderr.String())
|
t.Fatalf("exit code = %d, want 0; stderr=%q", code, stderr.String())
|
||||||
}
|
}
|
||||||
@@ -375,11 +369,7 @@ func TestExecuteUsesDefaultPipelineConfigPathWhenConfigFlagOmitted(t *testing.T)
|
|||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
|
|
||||||
pipelinePath, campaignPath, sessionPath := writeValidConfigFiles(t, workspaceRoot, srv.URL)
|
pipelinePath, campaignPath, sessionPath := writeValidConfigFiles(t, workspaceRoot, srv.URL)
|
||||||
originalDefaults := append([]string(nil), config.DefaultPipelineConfigSearchPaths...)
|
withDefaultPipelineCampaignConfigs(t, pipelinePath, campaignPath)
|
||||||
config.DefaultPipelineConfigSearchPaths = []string{pipelinePath}
|
|
||||||
defer func() {
|
|
||||||
config.DefaultPipelineConfigSearchPaths = originalDefaults
|
|
||||||
}()
|
|
||||||
_ = campaignPath
|
_ = campaignPath
|
||||||
|
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"io"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -109,6 +110,148 @@ func TestConfigArtifactsReportsOverlayFamilyContributors(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestConfigInspectionReportsInheritedCompositeSources(t *testing.T) {
|
||||||
|
t.Setenv("NARRATIO_CONFIG_INSPECTION_KEY", "synthetic-inspection-secret")
|
||||||
|
pipelinePath, campaignPath := writeInspectionFamilyConfig(t)
|
||||||
|
dir := filepath.Dir(pipelinePath)
|
||||||
|
parentPath := filepath.Join(dir, "families", "parent.yml")
|
||||||
|
childPath := filepath.Join(dir, "families", "child.yml")
|
||||||
|
overlayPath := filepath.Join(dir, "overlays", "testing.yml")
|
||||||
|
mustWriteTestFile(t, pipelinePath, `config:
|
||||||
|
imports:
|
||||||
|
- path: families/parent.yml
|
||||||
|
- path: families/child.yml
|
||||||
|
workspace:
|
||||||
|
root: `+filepath.Join(dir, "workspace")+`
|
||||||
|
campaigns:
|
||||||
|
root: `+filepath.Join(dir, "campaigns")+`
|
||||||
|
whisperx:
|
||||||
|
transcribe_url: https://transcription.example.com/transcribe
|
||||||
|
audita:
|
||||||
|
credentials: [NARRATIO_CONFIG_INSPECTION_KEY]
|
||||||
|
scriptorium:
|
||||||
|
extends: audita
|
||||||
|
`)
|
||||||
|
mustWriteTestFile(t, parentPath, `scriptorium:
|
||||||
|
artifact_families:
|
||||||
|
character_meta:
|
||||||
|
enabled: false
|
||||||
|
for_each: party.characters
|
||||||
|
prompt_id: dnd.character_meta
|
||||||
|
profile_id: production
|
||||||
|
output_path_pattern: artifacts/characters/{character_id}/meta.md
|
||||||
|
artifacts:
|
||||||
|
notes:
|
||||||
|
enabled: false
|
||||||
|
prompt_id: dnd.notes
|
||||||
|
`)
|
||||||
|
mustWriteTestFile(t, childPath, `scriptorium:
|
||||||
|
artifact_families:
|
||||||
|
character_note:
|
||||||
|
extends: character_meta
|
||||||
|
profile_id: testing
|
||||||
|
output_path_pattern: artifacts/characters/{character_id}/note.md
|
||||||
|
artifacts:
|
||||||
|
notes:
|
||||||
|
output_path: artifacts/notes.md
|
||||||
|
`)
|
||||||
|
mustWriteTestFile(t, overlayPath, `scriptorium:
|
||||||
|
artifact_families:
|
||||||
|
character_note:
|
||||||
|
prompt_id: dnd.character_note.testing
|
||||||
|
artifacts:
|
||||||
|
notes:
|
||||||
|
output_path: artifacts/notes-testing.md
|
||||||
|
`)
|
||||||
|
expandedOverlayPath := filepath.Join(dir, "overlays", "expanded.yml")
|
||||||
|
mustWriteTestFile(t, expandedOverlayPath, `scriptorium:
|
||||||
|
extends: null
|
||||||
|
credentials: [NARRATIO_CONFIG_INSPECTION_KEY]
|
||||||
|
artifact_families:
|
||||||
|
character_note:
|
||||||
|
enabled: false
|
||||||
|
for_each: party.characters
|
||||||
|
prompt_id: dnd.character_note.testing
|
||||||
|
profile_id: testing
|
||||||
|
output_path_pattern: artifacts/characters/{character_id}/note.md
|
||||||
|
artifacts:
|
||||||
|
notes:
|
||||||
|
output_path: artifacts/notes-testing.md
|
||||||
|
`)
|
||||||
|
args := []string{"--config", pipelinePath, "--campaign-file", campaignPath, "--overlay", "testing"}
|
||||||
|
if err := ConfigValidate(context.Background(), args, io.Discard); err != nil {
|
||||||
|
t.Fatalf("ConfigValidate() error = %v", err)
|
||||||
|
}
|
||||||
|
var effective bytes.Buffer
|
||||||
|
if err := ConfigShow(context.Background(), args, &effective); err != nil {
|
||||||
|
t.Fatalf("ConfigShow() error = %v", err)
|
||||||
|
}
|
||||||
|
for _, want := range []string{"NARRATIO_CONFIG_INSPECTION_KEY", "character_note_arannis:", "dnd.character_note.testing", "artifacts/characters/arannis/note.md"} {
|
||||||
|
if !strings.Contains(effective.String(), want) {
|
||||||
|
t.Errorf("effective show omitted %q:\n%s", want, effective.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(effective.String(), "synthetic-inspection-secret") {
|
||||||
|
t.Fatal("effective show exposed a credential value")
|
||||||
|
}
|
||||||
|
|
||||||
|
var catalog bytes.Buffer
|
||||||
|
if err := ConfigArtifacts(context.Background(), args, &catalog); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
records := catalogRecordsByKey(t, catalog.String())
|
||||||
|
notes := records["notes"]
|
||||||
|
if strings.Contains(catalog.String(), "synthetic-inspection-secret") {
|
||||||
|
t.Fatal("artifact catalog exposed a credential value")
|
||||||
|
}
|
||||||
|
if notes[4] != "artifacts/notes-testing.md" {
|
||||||
|
t.Fatalf("composed artifact output = %#v", notes)
|
||||||
|
}
|
||||||
|
for _, contributor := range []string{parentPath, childPath, overlayPath} {
|
||||||
|
if !strings.Contains(notes[2], contributor) {
|
||||||
|
t.Errorf("composed artifact definitions %q omit %q", notes[2], contributor)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
note := records["character_note_arannis"]
|
||||||
|
if note[4] != "artifacts/characters/arannis/note.md" || note[6] != "character_note" || note[7] != "arannis" {
|
||||||
|
t.Fatalf("inherited family catalog identity and output = %#v", note)
|
||||||
|
}
|
||||||
|
for _, contributor := range []string{parentPath, childPath, overlayPath} {
|
||||||
|
if !strings.Contains(note[2], contributor) || !strings.Contains(note[8], contributor) {
|
||||||
|
t.Errorf("family provenance = definitions %q, family sources %q; want %q", note[2], note[8], contributor)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var sources bytes.Buffer
|
||||||
|
if err := ConfigSources(context.Background(), args, &sources); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, want := range []string{
|
||||||
|
"scriptorium.artifacts.notes.output_path\toverlay\t" + overlayPath,
|
||||||
|
"scriptorium.artifacts.character_note_arannis.output_path\tfamily\t" + childPath,
|
||||||
|
"scriptorium.artifacts.character_note_arannis.prompt_id\tfamily\t" + overlayPath,
|
||||||
|
"scriptorium.credentials\troot\t" + pipelinePath,
|
||||||
|
} {
|
||||||
|
if !strings.Contains(sources.String(), want) {
|
||||||
|
t.Errorf("effective source output missing %q:\n%s", want, sources.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(sources.String(), "synthetic-inspection-secret") {
|
||||||
|
t.Fatal("source inspection exposed a credential value")
|
||||||
|
}
|
||||||
|
var diff bytes.Buffer
|
||||||
|
if err := ConfigDiff(context.Background(), []string{"testing", "expanded", "--config", pipelinePath, "--campaign-file", campaignPath}, &diff); err != nil {
|
||||||
|
t.Fatalf("ConfigDiff() error = %v", err)
|
||||||
|
}
|
||||||
|
if diff.String() != "no differences\n" {
|
||||||
|
t.Fatalf("equivalent inherited/expanded overlays diff = %q", diff.String())
|
||||||
|
}
|
||||||
|
if strings.Contains(diff.String(), "synthetic-inspection-secret") {
|
||||||
|
t.Fatal("configuration diff exposed a credential value")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestConfigArtifactsReportsBaseAndOverlayContributors(t *testing.T) {
|
func TestConfigArtifactsReportsBaseAndOverlayContributors(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
pipelinePath := filepath.Join(dir, "pipeline.yml")
|
pipelinePath := filepath.Join(dir, "pipeline.yml")
|
||||||
@@ -198,7 +341,7 @@ func catalogRecordsByKey(t *testing.T, output string) map[string][]string {
|
|||||||
func artifactIdentityPipeline(importPath, inlineKey string) string {
|
func artifactIdentityPipeline(importPath, inlineKey string) string {
|
||||||
document := "workspace:\n root: /srv/narratio\nwhisperx:\n transcribe_url: https://transcription.example.com/transcribe\nscriptorium:\n binary: scriptorium\n"
|
document := "workspace:\n root: /srv/narratio\nwhisperx:\n transcribe_url: https://transcription.example.com/transcribe\nscriptorium:\n binary: scriptorium\n"
|
||||||
if importPath != "" {
|
if importPath != "" {
|
||||||
document = "configkit:\n imports:\n - path: " + importPath + "\n" + document
|
document = "config:\n imports:\n - path: " + importPath + "\n" + document
|
||||||
}
|
}
|
||||||
if inlineKey != "" {
|
if inlineKey != "" {
|
||||||
document += " artifacts:\n " + inlineKey + ":\n enabled: false\n output_path: artifacts/recap.md\n"
|
document += " artifacts:\n " + inlineKey + ":\n enabled: false\n output_path: artifacts/recap.md\n"
|
||||||
|
|||||||
@@ -140,6 +140,11 @@ func configSourcesWithDependencies(_ context.Context, args []string, out io.Writ
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
for _, selection := range config.EffectiveEmptyImports(resolved.Pipeline, resolved.Campaign) {
|
||||||
|
if _, err := fmt.Fprintf(out, "empty_import\t%s\t%s\t%s:%d:%d\n", selection.Path, selection.Selector, selection.Source, selection.Line, selection.Column); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -178,7 +183,7 @@ func configArtifactsWithDependencies(_ context.Context, args []string, out io.Wr
|
|||||||
strings.Join(record.Dependencies, ","),
|
strings.Join(record.Dependencies, ","),
|
||||||
record.FamilyKey,
|
record.FamilyKey,
|
||||||
record.CharacterID,
|
record.CharacterID,
|
||||||
config.NormalizedConfigurationPath(record.FamilySource),
|
strings.Join(normalizedCatalogPaths(record.FamilySources), ","),
|
||||||
config.NormalizedConfigurationPath(record.PartySource),
|
config.NormalizedConfigurationPath(record.PartySource),
|
||||||
}
|
}
|
||||||
for index := range fields {
|
for index := range fields {
|
||||||
@@ -217,7 +222,7 @@ func parseInspectionFlags(command string, args []string, out io.Writer) (inspect
|
|||||||
flags.overlay.name = "overlay"
|
flags.overlay.name = "overlay"
|
||||||
fs.Var(&flags.overlay, "overlay", "named pipeline overlay")
|
fs.Var(&flags.overlay, "overlay", "named pipeline overlay")
|
||||||
flags.secretsDir.name = "secrets-dir"
|
flags.secretsDir.name = "secrets-dir"
|
||||||
fs.Var(&flags.secretsDir, "secrets-dir", "secrets directory (optional; defaults beside pipeline.yml)")
|
fs.Var(&flags.secretsDir, "secrets-dir", "secrets directory (optional; defaults to /usr/local/etc/narratio/secrets)")
|
||||||
fs.Usage = func() {
|
fs.Usage = func() {
|
||||||
fmt.Fprintf(out, "Usage: narratio %s [--config <pipeline.yml>] [--campaign <id> | --campaign-file <campaign.yml>] [--overlay <name>] [--secrets-dir <path>]\n\n", command)
|
fmt.Fprintf(out, "Usage: narratio %s [--config <pipeline.yml>] [--campaign <id> | --campaign-file <campaign.yml>] [--overlay <name>] [--secrets-dir <path>]\n\n", command)
|
||||||
fmt.Fprintln(out, "Resolves configuration without a session, workspace, manifest, adapters, or external services.")
|
fmt.Fprintln(out, "Resolves configuration without a session, workspace, manifest, adapters, or external services.")
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||||
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestConfigCommandHelpAndDispatch(t *testing.T) {
|
func TestConfigCommandHelpAndDispatch(t *testing.T) {
|
||||||
@@ -186,24 +186,24 @@ scriptorium:
|
|||||||
}
|
}
|
||||||
output := first.String()
|
output := first.String()
|
||||||
for _, want := range []string{
|
for _, want := range []string{
|
||||||
"changed\taudita.modules\t[\"glossary\",\"grammar\"]\t[]\n",
|
"changed\t/audita/modules\t[\"glossary\",\"grammar\"]\t[]\n",
|
||||||
"changed\tworkspace.cleanup_after_publish\ttrue\tfalse\n",
|
"changed\t/workspace/cleanup_after_publish\ttrue\tfalse\n",
|
||||||
"changed\twhisperx.language\t\"en\"\t\"fr\"\n",
|
"changed\t/whisperx/language\t\"en\"\t\"fr\"\n",
|
||||||
"removed\tscriptorium.artifacts.production_only.enabled\tfalse\n",
|
"removed\t/scriptorium/artifacts/production_only\t{",
|
||||||
"added\tscriptorium.artifacts.testing_only.enabled\tfalse\n",
|
"added\t/scriptorium/artifacts/testing_only\t{",
|
||||||
} {
|
} {
|
||||||
if !strings.Contains(output, want) {
|
if !strings.Contains(output, want) {
|
||||||
t.Fatalf("diff output missing %q:\n%s", want, output)
|
t.Fatalf("diff output missing %q:\n%s", want, output)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if strings.Index(output, "audita.modules") > strings.Index(output, "workspace.cleanup_after_publish") {
|
if strings.Index(output, "/audita/modules") > strings.Index(output, "/workspace/cleanup_after_publish") {
|
||||||
t.Fatalf("diff records are not sorted by path:\n%s", output)
|
t.Fatalf("diff records are not sorted by path:\n%s", output)
|
||||||
}
|
}
|
||||||
var reversed bytes.Buffer
|
var reversed bytes.Buffer
|
||||||
if err := ConfigDiff(context.Background(), []string{"testing", "production", "--config", pipelinePath}, &reversed); err != nil {
|
if err := ConfigDiff(context.Background(), []string{"testing", "production", "--config", pipelinePath}, &reversed); err != nil {
|
||||||
t.Fatalf("reversed ConfigDiff() error = %v", err)
|
t.Fatalf("reversed ConfigDiff() error = %v", err)
|
||||||
}
|
}
|
||||||
if !strings.Contains(reversed.String(), "changed\twhisperx.language\t\"fr\"\t\"en\"\n") {
|
if !strings.Contains(reversed.String(), "changed\t/whisperx/language\t\"fr\"\t\"en\"\n") {
|
||||||
t.Fatalf("reversed diff did not independently resolve overlays:\n%s", reversed.String())
|
t.Fatalf("reversed diff did not independently resolve overlays:\n%s", reversed.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -249,8 +249,8 @@ scriptorium:
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
for _, want := range []string{
|
for _, want := range []string{
|
||||||
"changed\taudita.modules\tnull\t[]\n",
|
"changed\t/audita/modules\tnull\t[]\n",
|
||||||
"changed\tscriptorium.artifacts\tnull\t{}\n",
|
"changed\t/scriptorium/artifacts\tnull\t{}\n",
|
||||||
} {
|
} {
|
||||||
if !strings.Contains(diff.String(), want) {
|
if !strings.Contains(diff.String(), want) {
|
||||||
t.Fatalf("diff output missing %q:\n%s", want, diff.String())
|
t.Fatalf("diff output missing %q:\n%s", want, diff.String())
|
||||||
@@ -289,9 +289,9 @@ func TestConfigDiffComparesExpandedFamiliesAndPublishRules(t *testing.T) {
|
|||||||
}
|
}
|
||||||
output := out.String()
|
output := out.String()
|
||||||
for _, want := range []string{
|
for _, want := range []string{
|
||||||
"changed\tscriptorium.artifacts.character_note_arannis.enabled\tfalse\ttrue\n",
|
"changed\t/scriptorium/artifacts/character_note_arannis/enabled\tfalse\ttrue\n",
|
||||||
"changed\tscriptorium.artifacts.character_note_arannis.vars.character_name\t\"Arannis\"\t\"wizard\"\n",
|
"changed\t/scriptorium/artifacts/character_note_arannis/vars/character_name\t\"Arannis\"\t\"wizard\"\n",
|
||||||
"changed\tpublish.outputs\t",
|
"changed\t/publish/outputs\t",
|
||||||
} {
|
} {
|
||||||
if !strings.Contains(output, want) {
|
if !strings.Contains(output, want) {
|
||||||
t.Fatalf("family diff output missing %q:\n%s", want, output)
|
t.Fatalf("family diff output missing %q:\n%s", want, output)
|
||||||
@@ -339,23 +339,33 @@ func TestConfigDiffBootstrapsSecretsOnceForBothOverlays(t *testing.T) {
|
|||||||
}
|
}
|
||||||
mustWriteSecretFile(t, filepath.Join(secretsDir, secretName), "diff-secret-must-not-appear\n")
|
mustWriteSecretFile(t, filepath.Join(secretsDir, secretName), "diff-secret-must-not-appear\n")
|
||||||
bootstrapCalls := 0
|
bootstrapCalls := 0
|
||||||
|
var loadedPaths []string
|
||||||
var diagnostics bytes.Buffer
|
var diagnostics bytes.Buffer
|
||||||
deps := commandDependencies{loadSecretsDir: func(got string) (*configkit.SecretsReport, error) {
|
deps := commandDependencies{loadSecretsDir: func(got string) (*configkit.SecretsReport, error) {
|
||||||
bootstrapCalls++
|
bootstrapCalls++
|
||||||
if got != secretsDir {
|
if got != secretsDir {
|
||||||
t.Fatalf("secrets directory = %q, want %q", got, secretsDir)
|
t.Fatalf("secrets directory = %q, want %q", got, secretsDir)
|
||||||
}
|
}
|
||||||
return configkit.LoadSecretsDir(got)
|
return configkit.LoadSecretsIntoEnvironment(got)
|
||||||
}, diagnostics: &diagnostics}
|
}, diagnostics: &diagnostics}
|
||||||
|
search := configkit.SearchPaths(pipelinePath)
|
||||||
|
deps.pipelineSearch = &search
|
||||||
|
deps.loadPipelineConfig = func(path string, opts config.PipelineLoadOptions) (*config.PipelineConfig, error) {
|
||||||
|
loadedPaths = append(loadedPaths, path)
|
||||||
|
return config.LoadPipelineWithOptions(path, opts)
|
||||||
|
}
|
||||||
|
|
||||||
if err := configDiffWithDependencies(context.Background(), []string{
|
if err := configDiffWithDependencies(context.Background(), []string{
|
||||||
"production", "testing", "--config", pipelinePath, "--secrets-dir", secretsDir,
|
"production", "testing", "--secrets-dir", secretsDir,
|
||||||
}, io.Discard, deps); err != nil {
|
}, io.Discard, deps); err != nil {
|
||||||
t.Fatalf("config diff: %v", err)
|
t.Fatalf("config diff: %v", err)
|
||||||
}
|
}
|
||||||
if bootstrapCalls != 1 {
|
if bootstrapCalls != 1 {
|
||||||
t.Fatalf("bootstrap calls = %d, want 1", bootstrapCalls)
|
t.Fatalf("bootstrap calls = %d, want 1", bootstrapCalls)
|
||||||
}
|
}
|
||||||
|
if len(loadedPaths) != 2 || loadedPaths[0] != "" || loadedPaths[1] != pipelinePath {
|
||||||
|
t.Fatalf("pipeline load paths = %q, want discovery then selected root %q", loadedPaths, pipelinePath)
|
||||||
|
}
|
||||||
if got := diagnostics.String(); strings.Count(got, `name="`+secretName+`"`) != 1 {
|
if got := diagnostics.String(); strings.Count(got, `name="`+secretName+`"`) != 1 {
|
||||||
t.Fatalf("bootstrap report count = %d, want 1; diagnostics = %q", strings.Count(got, `name="`+secretName+`"`), got)
|
t.Fatalf("bootstrap report count = %d, want 1; diagnostics = %q", strings.Count(got, `name="`+secretName+`"`), got)
|
||||||
}
|
}
|
||||||
@@ -476,7 +486,7 @@ func TestConfigCommandsInspectMaintainedSplitBundleWithoutRuntimeState(t *testin
|
|||||||
if err := ConfigDiff(context.Background(), []string{"default", "testing", "--config", pipelinePath, "--campaign-file", campaignPath}, &diff); err != nil {
|
if err := ConfigDiff(context.Background(), []string{"default", "testing", "--config", pipelinePath, "--campaign-file", campaignPath}, &diff); err != nil {
|
||||||
t.Fatalf("ConfigDiff() error = %v", err)
|
t.Fatalf("ConfigDiff() error = %v", err)
|
||||||
}
|
}
|
||||||
if !strings.Contains(diff.String(), "audita.proposal_profile") {
|
if !strings.Contains(diff.String(), "/audita/proposal_profile") {
|
||||||
t.Fatalf("split bundle overlay diff = %q, want proposal profile change", diff.String())
|
t.Fatalf("split bundle overlay diff = %q, want proposal profile change", diff.String())
|
||||||
}
|
}
|
||||||
if _, err := os.Stat(workspacePath); !os.IsNotExist(err) {
|
if _, err := os.Stat(workspacePath); !os.IsNotExist(err) {
|
||||||
@@ -572,7 +582,7 @@ func TestConfigValidateReportsCanonicalPartyAndImportErrors(t *testing.T) {
|
|||||||
|
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
rootPath := filepath.Join(dir, "pipeline.yml")
|
rootPath := filepath.Join(dir, "pipeline.yml")
|
||||||
mustWriteTestFile(t, rootPath, `configkit:
|
mustWriteTestFile(t, rootPath, `config:
|
||||||
imports:
|
imports:
|
||||||
- path: conf.yml
|
- path: conf.yml
|
||||||
workspace:
|
workspace:
|
||||||
@@ -673,7 +683,7 @@ func TestConfigSourcesAttributesInferredArtifactDependencies(t *testing.T) {
|
|||||||
pipelinePath := filepath.Join(dir, "pipeline.yml")
|
pipelinePath := filepath.Join(dir, "pipeline.yml")
|
||||||
inputPath := filepath.Join(dir, "input-only.yml")
|
inputPath := filepath.Join(dir, "input-only.yml")
|
||||||
overlayPath := filepath.Join(dir, "overlays", "testing.yml")
|
overlayPath := filepath.Join(dir, "overlays", "testing.yml")
|
||||||
mustWriteTestFile(t, pipelinePath, `configkit:
|
mustWriteTestFile(t, pipelinePath, `config:
|
||||||
imports:
|
imports:
|
||||||
- path: input-only.yml
|
- path: input-only.yml
|
||||||
workspace:
|
workspace:
|
||||||
@@ -733,7 +743,7 @@ func TestConfigSourcesReportsRootImportOverlayAndDefaultOwnership(t *testing.T)
|
|||||||
rootPath := filepath.Join(dir, "pipeline.yml")
|
rootPath := filepath.Join(dir, "pipeline.yml")
|
||||||
importPath := filepath.Join(dir, "base.yml")
|
importPath := filepath.Join(dir, "base.yml")
|
||||||
overlayPath := filepath.Join(dir, "overlays", "testing.yml")
|
overlayPath := filepath.Join(dir, "overlays", "testing.yml")
|
||||||
mustWriteTestFile(t, rootPath, `configkit:
|
mustWriteTestFile(t, rootPath, `config:
|
||||||
imports:
|
imports:
|
||||||
- path: base.yml
|
- path: base.yml
|
||||||
workspace:
|
workspace:
|
||||||
@@ -813,3 +823,104 @@ characters:
|
|||||||
`)
|
`)
|
||||||
return pipelinePath, campaignPath
|
return pipelinePath, campaignPath
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestNativeBundleInspectionAndExecutionAgree(t *testing.T) {
|
||||||
|
examples, err := filepath.Abs(filepath.Join("..", "..", "examples"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
bundle := t.TempDir()
|
||||||
|
if err := os.CopyFS(bundle, os.DirFS(examples)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
root := filepath.Join(bundle, "production-testing")
|
||||||
|
pipeline := filepath.Join(root, "narratio.yml")
|
||||||
|
if err := os.Rename(filepath.Join(root, "pipeline.yml"), pipeline); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
f, err := os.OpenFile(pipeline, os.O_APPEND|os.O_WRONLY, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := f.WriteString("\naudita:\n credentials: [NARRATIO_BUNDLE_TEST_KEY]\n"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := f.Close(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
const secretName = "NARRATIO_BUNDLE_TEST_KEY"
|
||||||
|
const secretValue = "synthetic-bundle-secret"
|
||||||
|
restoreEnvAfterTest(t, secretName)
|
||||||
|
if err := os.Unsetenv(secretName); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
secrets := filepath.Join(bundle, "secrets")
|
||||||
|
mustWriteSecretFile(t, filepath.Join(secrets, secretName), secretValue)
|
||||||
|
t.Chdir(root)
|
||||||
|
campaign := filepath.Join(bundle, "campaigns", "sample-campaign", "campaign.yml")
|
||||||
|
common := []string{"--campaign-file", campaign, "--secrets-dir", secrets}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
run func(context.Context, []string, io.Writer) error
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{"validate", ConfigValidate, []string{pipeline}},
|
||||||
|
{"show", ConfigShow, []string{"NARRATIO_BUNDLE_TEST_KEY", "character_meta_arannis"}},
|
||||||
|
{"sources", ConfigSources, []string{"empty_import", "brenna.yml"}},
|
||||||
|
{"artifacts", ConfigArtifacts, []string{"session_recap", "character_meta_arannis"}},
|
||||||
|
} {
|
||||||
|
var out bytes.Buffer
|
||||||
|
if err := tc.run(context.Background(), common, &out); err != nil {
|
||||||
|
t.Fatalf("%s: %v", tc.name, err)
|
||||||
|
}
|
||||||
|
for _, want := range tc.want {
|
||||||
|
if !strings.Contains(out.String(), want) {
|
||||||
|
t.Errorf("%s output missing %q: %s", tc.name, want, out.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(out.String(), secretValue) {
|
||||||
|
t.Errorf("%s exposed credential value", tc.name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var diff bytes.Buffer
|
||||||
|
args := append([]string{"default", "testing"}, common...)
|
||||||
|
if err := ConfigDiff(context.Background(), args, &diff); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(diff.String(), "/audita/proposal_profile") || strings.Contains(diff.String(), secretValue) {
|
||||||
|
t.Fatalf("unexpected diff: %s", diff.String())
|
||||||
|
}
|
||||||
|
workspace := filepath.Join(root, "conf.d", "workspace")
|
||||||
|
if _, err := os.Stat(workspace); !os.IsNotExist(err) {
|
||||||
|
t.Fatalf("inspection created workspace: %v", err)
|
||||||
|
}
|
||||||
|
var execution *config.Config
|
||||||
|
executor := func(_ context.Context, cfg *config.Config, _ BoundedPlan, _ RunOptions) (*RunSummary, error) {
|
||||||
|
execution = cfg
|
||||||
|
return &RunSummary{SessionID: "2026-05-03"}, nil
|
||||||
|
}
|
||||||
|
runArgs := append([]string{"2026-05-03", "--session", filepath.Join(bundle, "session.local-audio.yml"), "--overlay", "testing"}, common...)
|
||||||
|
var plan bytes.Buffer
|
||||||
|
planArgs := append(append([]string{}, runArgs...), "--from", "prepare", "--through", "prepare")
|
||||||
|
if err := Plan(context.Background(), planArgs, &plan); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(plan.String(), "prepare: run") {
|
||||||
|
t.Fatalf("unexpected plan: %s", plan.String())
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(workspace); !os.IsNotExist(err) {
|
||||||
|
t.Fatalf("plan created workspace: %v", err)
|
||||||
|
}
|
||||||
|
if err := runWithPipelineExecutor(context.Background(), runArgs, io.Discard, executor); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if execution == nil || execution.Session.Inputs.AudioDir != filepath.Join(bundle, "audio") || execution.Campaign.Inputs.PartyFile != filepath.Join(bundle, "campaigns", "sample-campaign", "party.yml") {
|
||||||
|
t.Fatalf("execution did not resolve imported session and campaign resources: %+v", execution)
|
||||||
|
}
|
||||||
|
if execution.Pipeline.Audita.ProposalProfile != "narratio-testing-model-placeholder" {
|
||||||
|
t.Fatalf("execution did not use the inspected overlay: %q", execution.Pipeline.Audita.ProposalProfile)
|
||||||
|
}
|
||||||
|
if _, ok := execution.Pipeline.Scriptorium.Artifacts["character_meta_arannis"]; !ok {
|
||||||
|
t.Fatal("execution did not expand the inspected party family")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,14 +2,16 @@ package app
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"sort"
|
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||||
|
configkit "go.maximumdirect.net/configkit"
|
||||||
|
"gopkg.in/yaml.v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
type configDiffFlags struct {
|
type configDiffFlags struct {
|
||||||
@@ -30,13 +32,6 @@ type configDiffResolved struct {
|
|||||||
right *inspectionConfig
|
right *inspectionConfig
|
||||||
}
|
}
|
||||||
|
|
||||||
type configDiffRecord struct {
|
|
||||||
Kind string
|
|
||||||
Path string
|
|
||||||
Left string
|
|
||||||
Right string
|
|
||||||
}
|
|
||||||
|
|
||||||
// ConfigDiff compares two explicitly selected overlays through the same
|
// ConfigDiff compares two explicitly selected overlays through the same
|
||||||
// read-only configuration resolution boundary used by config validate, show,
|
// read-only configuration resolution boundary used by config validate, show,
|
||||||
// and sources. Differences describe normalized effective values rather than
|
// and sources. Differences describe normalized effective values rather than
|
||||||
@@ -57,43 +52,42 @@ func configDiffWithDependencies(_ context.Context, args []string, out io.Writer,
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("config diff: %w", err)
|
return fmt.Errorf("config diff: %w", err)
|
||||||
}
|
}
|
||||||
leftValues, err := config.EffectivePipelineValues(resolved.left.Pipeline)
|
differences, err := config.DiffEffectivePipelines(resolved.left.Pipeline, resolved.right.Pipeline)
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("config diff: project left effective configuration: %w", err)
|
|
||||||
}
|
|
||||||
rightValues, err := config.EffectivePipelineValues(resolved.right.Pipeline)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("config diff: project right effective configuration: %w", err)
|
|
||||||
}
|
|
||||||
records, err := diffEffectivePipelineValues(leftValues, rightValues)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("config diff: %w", err)
|
return fmt.Errorf("config diff: %w", err)
|
||||||
}
|
}
|
||||||
leftDigest := config.EffectivePipelineDigest(resolved.left.Pipeline)
|
if len(differences) == 0 {
|
||||||
rightDigest := config.EffectivePipelineDigest(resolved.right.Pipeline)
|
|
||||||
if len(records) == 0 {
|
|
||||||
if leftDigest != rightDigest {
|
|
||||||
return fmt.Errorf("internal error: effective pipeline digests differ without a semantic difference")
|
|
||||||
}
|
|
||||||
_, err := fmt.Fprintln(out, "no differences")
|
_, err := fmt.Fprintln(out, "no differences")
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
for _, record := range records {
|
for _, difference := range differences {
|
||||||
switch record.Kind {
|
kind := "changed"
|
||||||
case "added":
|
if !difference.Left.Present {
|
||||||
if _, err := fmt.Fprintf(out, "added\t%s\t%s\n", record.Path, record.Right); err != nil {
|
kind = "added"
|
||||||
|
}
|
||||||
|
if !difference.Right.Present {
|
||||||
|
kind = "removed"
|
||||||
|
}
|
||||||
|
fields := []string{kind, difference.Path.String()}
|
||||||
|
if difference.Left.Present {
|
||||||
|
value, err := compactSnapshot(difference.Left)
|
||||||
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
case "removed":
|
fields = append(fields, value)
|
||||||
if _, err := fmt.Fprintf(out, "removed\t%s\t%s\n", record.Path, record.Left); err != nil {
|
}
|
||||||
|
if difference.Right.Present {
|
||||||
|
value, err := compactSnapshot(difference.Right)
|
||||||
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
case "changed":
|
fields = append(fields, value)
|
||||||
if _, err := fmt.Fprintf(out, "changed\t%s\t%s\t%s\n", record.Path, record.Left, record.Right); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
default:
|
if difference.HiddenChanged {
|
||||||
return fmt.Errorf("internal error: unsupported difference kind %q", record.Kind)
|
fields = append(fields, "hidden_changed=true")
|
||||||
|
}
|
||||||
|
if _, err := fmt.Fprintln(out, strings.Join(fields, "\t")); err != nil {
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
@@ -111,7 +105,7 @@ func parseConfigDiffRequest(args []string, out io.Writer) (configDiffRequest, er
|
|||||||
fs.Var(&request.flags.pipelinePath, "config", "path to pipeline.yml (optional; defaults searched)")
|
fs.Var(&request.flags.pipelinePath, "config", "path to pipeline.yml (optional; defaults searched)")
|
||||||
fs.Var(&request.flags.campaignPath, "campaign", "campaign ID")
|
fs.Var(&request.flags.campaignPath, "campaign", "campaign ID")
|
||||||
fs.Var(&request.flags.campaignFilePath, "campaign-file", "path to campaign.yml")
|
fs.Var(&request.flags.campaignFilePath, "campaign-file", "path to campaign.yml")
|
||||||
fs.Var(&request.flags.secretsDir, "secrets-dir", "secrets directory (optional; defaults beside pipeline.yml)")
|
fs.Var(&request.flags.secretsDir, "secrets-dir", "secrets directory (optional; defaults to /usr/local/etc/narratio/secrets)")
|
||||||
fs.Usage = func() {
|
fs.Usage = func() {
|
||||||
fmt.Fprintln(out, "Usage: narratio config diff <left-overlay> <right-overlay> [--config <pipeline.yml>] [--campaign <id> | --campaign-file <campaign.yml>] [--secrets-dir <path>]")
|
fmt.Fprintln(out, "Usage: narratio config diff <left-overlay> <right-overlay> [--config <pipeline.yml>] [--campaign <id> | --campaign-file <campaign.yml>] [--secrets-dir <path>]")
|
||||||
fmt.Fprintln(out)
|
fmt.Fprintln(out)
|
||||||
@@ -179,7 +173,7 @@ func resolveConfigDiff(request configDiffRequest, deps commandDependencies) (*co
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("load left pipeline overlay: %w", err)
|
return nil, fmt.Errorf("load left pipeline overlay: %w", err)
|
||||||
}
|
}
|
||||||
_, rightPipeline, err := loadPipelineConfigWithDependencies(request.flags.pipelinePath.value, config.PipelineLoadOptions{Overlay: &request.rightOverlay}, request.flags.secretsDir.pointer(), deps)
|
_, rightPipeline, err := loadPipelineConfigWithDependencies(pipelinePath, config.PipelineLoadOptions{Overlay: &request.rightOverlay}, request.flags.secretsDir.pointer(), deps)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("load right pipeline overlay: %w", err)
|
return nil, fmt.Errorf("load right pipeline overlay: %w", err)
|
||||||
}
|
}
|
||||||
@@ -264,50 +258,14 @@ func resolveSharedDiffCampaignPath(left, right *config.PipelineConfig, flags con
|
|||||||
return leftPath, nil
|
return leftPath, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func diffEffectivePipelineValues(left, right []config.EffectivePipelineValueRecord) ([]configDiffRecord, error) {
|
func compactSnapshot(snapshot configkit.ValueSnapshot) (string, error) {
|
||||||
leftByPath, err := effectivePipelineValueMap("left", left)
|
var value any
|
||||||
|
if err := yaml.Unmarshal([]byte(snapshot.YAML), &value); err != nil {
|
||||||
|
return "", fmt.Errorf("decode safe diff value: %w", err)
|
||||||
|
}
|
||||||
|
encoded, err := json.Marshal(value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return "", fmt.Errorf("encode safe diff value: %w", err)
|
||||||
}
|
}
|
||||||
rightByPath, err := effectivePipelineValueMap("right", right)
|
return string(encoded), nil
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
paths := make([]string, 0, len(leftByPath)+len(rightByPath))
|
|
||||||
seen := make(map[string]struct{}, len(leftByPath)+len(rightByPath))
|
|
||||||
for path := range leftByPath {
|
|
||||||
seen[path] = struct{}{}
|
|
||||||
paths = append(paths, path)
|
|
||||||
}
|
|
||||||
for path := range rightByPath {
|
|
||||||
if _, exists := seen[path]; !exists {
|
|
||||||
paths = append(paths, path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sort.Strings(paths)
|
|
||||||
records := make([]configDiffRecord, 0)
|
|
||||||
for _, path := range paths {
|
|
||||||
leftValue, leftExists := leftByPath[path]
|
|
||||||
rightValue, rightExists := rightByPath[path]
|
|
||||||
switch {
|
|
||||||
case !leftExists:
|
|
||||||
records = append(records, configDiffRecord{Kind: "added", Path: path, Right: rightValue})
|
|
||||||
case !rightExists:
|
|
||||||
records = append(records, configDiffRecord{Kind: "removed", Path: path, Left: leftValue})
|
|
||||||
case leftValue != rightValue:
|
|
||||||
records = append(records, configDiffRecord{Kind: "changed", Path: path, Left: leftValue, Right: rightValue})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return records, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func effectivePipelineValueMap(side string, records []config.EffectivePipelineValueRecord) (map[string]string, error) {
|
|
||||||
values := make(map[string]string, len(records))
|
|
||||||
for _, record := range records {
|
|
||||||
if _, exists := values[record.Path]; exists {
|
|
||||||
return nil, fmt.Errorf("internal error: %s effective configuration has duplicate path %q", side, record.Path)
|
|
||||||
}
|
|
||||||
values[record.Path] = record.Value
|
|
||||||
}
|
|
||||||
return values, nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,8 +2,11 @@ package app
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -59,12 +62,12 @@ func loadCommandConfigWithDependencies(ctx context.Context, pipelineFlag, campai
|
|||||||
return retainedCommandConfig(cfg), nil
|
return retainedCommandConfig(cfg), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
discoveredSession, err := discoverSessionConfigPathWithCandidates(config.DefaultSessionConfigSearchPaths)
|
discoveredSession, discoveredPath, err := config.DiscoverSession(config.DefaultSessionConfigSearchPaths, sessionOpts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
if discoveredSession.Path != "" {
|
if discoveredSession != nil {
|
||||||
cfg, err := config.LoadSessionWithPipelineCampaignOptions(*base, discoveredSession.Path, sessionOpts)
|
cfg, err := config.ResolveLoadedPipelineCampaign(*base, discoveredPath, discoveredSession, config.SessionSource{Source: "session_config", LocalPath: discoveredPath})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -73,7 +76,7 @@ func loadCommandConfigWithDependencies(ctx context.Context, pipelineFlag, campai
|
|||||||
|
|
||||||
sessionID := strings.TrimSpace(sessionOpts.SessionID)
|
sessionID := strings.TrimSpace(sessionOpts.SessionID)
|
||||||
if sessionID == "" {
|
if sessionID == "" {
|
||||||
return nil, missingSessionConfigError(discoveredSession.Searched, "remote session loading requires a session_id")
|
return nil, missingSessionConfigError(config.DefaultSessionConfigSearchPaths, "remote session loading requires a session_id")
|
||||||
}
|
}
|
||||||
|
|
||||||
rootPrefix := ""
|
rootPrefix := ""
|
||||||
@@ -88,27 +91,41 @@ func loadCommandConfigWithDependencies(ctx context.Context, pipelineFlag, campai
|
|||||||
}
|
}
|
||||||
store, err := newCommandObjectStoreWithDependencies(ctx, partialCfg, nil, deps)
|
store, err := newCommandObjectStoreWithDependencies(ctx, partialCfg, nil, deps)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, missingSessionConfigError(discoveredSession.Searched, fmt.Sprintf("remote session %q unavailable: %v", remoteKey, err))
|
return nil, missingSessionConfigError(config.DefaultSessionConfigSearchPaths, fmt.Sprintf("remote session %q unavailable: %v", remoteKey, err))
|
||||||
}
|
}
|
||||||
|
|
||||||
sessionInfo, err := findRemoteSessionConfig(ctx, store, sessionPrefix, remoteKey)
|
sessionInfo, checksum, body, err := findRemoteSessionConfig(ctx, store, sessionPrefix, remoteKey, config.CampaignID(base.Campaign), sessionID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, missingSessionConfigError(discoveredSession.Searched, err.Error())
|
return nil, missingSessionConfigError(config.DefaultSessionConfigSearchPaths, err.Error())
|
||||||
}
|
}
|
||||||
sessionTempPath, err := deps.downloadObjectToTemp(ctx, store, remoteKey, "narratio-session-*.yml")
|
defer body.Close()
|
||||||
|
remoteKey = sessionInfo.Key
|
||||||
|
temporary, err := os.CreateTemp("", "narratio-session-*.yml")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, missingSessionConfigError(discoveredSession.Searched, fmt.Sprintf("remote session %q download failed: %v", remoteKey, err))
|
return nil, missingSessionConfigError(config.DefaultSessionConfigSearchPaths, fmt.Sprintf("remote session %q download failed: %v", remoteKey, err))
|
||||||
}
|
}
|
||||||
|
sessionTempPath := temporary.Name()
|
||||||
cleanup = func() error {
|
cleanup = func() error {
|
||||||
if err := fileops.RemoveAllUnderRoot(filepath.Dir(sessionTempPath), sessionTempPath); err != nil {
|
if err := fileops.RemoveAllUnderRoot(filepath.Dir(sessionTempPath), sessionTempPath); err != nil {
|
||||||
return fmt.Errorf("remove downloaded remote session config: %w", err)
|
return fmt.Errorf("remove downloaded remote session config: %w", err)
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
_, copyErr := io.Copy(temporary, body)
|
||||||
|
closeErr := temporary.Close()
|
||||||
|
if err := errors.Join(copyErr, closeErr); err != nil {
|
||||||
|
return nil, fmt.Errorf("download remote session %q: %w", remoteKey, err)
|
||||||
|
}
|
||||||
sessionBytes, err := os.ReadFile(sessionTempPath)
|
sessionBytes, err := os.ReadFile(sessionTempPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("read downloaded remote session config: %w", err)
|
return nil, fmt.Errorf("read downloaded remote session config: %w", err)
|
||||||
}
|
}
|
||||||
|
if checksum != "" {
|
||||||
|
digest := sha256.Sum256(sessionBytes)
|
||||||
|
if !strings.EqualFold(hex.EncodeToString(digest[:]), checksum) || int64(len(sessionBytes)) != sessionInfo.Size {
|
||||||
|
return nil, fmt.Errorf("remote session %q does not match its committed checksum or size", remoteKey)
|
||||||
|
}
|
||||||
|
}
|
||||||
sessionCfg, err := config.LoadSessionBytesWithOptions("s3://"+s3BucketName(base.Pipeline)+"/"+remoteKey, sessionBytes, sessionOpts)
|
sessionCfg, err := config.LoadSessionBytesWithOptions("s3://"+s3BucketName(base.Pipeline)+"/"+remoteKey, sessionBytes, sessionOpts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -163,35 +180,65 @@ func loadPipelineCampaignConfigWithDependencies(pipelineFlag, campaignFlag, camp
|
|||||||
|
|
||||||
func loadPipelineConfigWithDependencies(pipelineFlag string, opts config.PipelineLoadOptions, secretsDir *string, deps commandDependencies) (string, *config.PipelineConfig, error) {
|
func loadPipelineConfigWithDependencies(pipelineFlag string, opts config.PipelineLoadOptions, secretsDir *string, deps commandDependencies) (string, *config.PipelineConfig, error) {
|
||||||
deps = normalizeCommandDependencies(deps)
|
deps = normalizeCommandDependencies(deps)
|
||||||
resolvedPipelinePath, err := deps.resolvePipelineConfigPath(pipelineFlag)
|
|
||||||
if err != nil {
|
|
||||||
return "", nil, err
|
|
||||||
}
|
|
||||||
if !deps.secretsBootstrap.selectionSet {
|
if !deps.secretsBootstrap.selectionSet {
|
||||||
deps.secretsBootstrap.selection = secretsDir
|
deps.secretsBootstrap.selection = secretsDir
|
||||||
deps.secretsBootstrap.selectionSet = true
|
deps.secretsBootstrap.selectionSet = true
|
||||||
}
|
}
|
||||||
if err := deps.secretsBootstrap.load(resolvedPipelinePath, deps.loadSecretsDir, deps.diagnostics); err != nil {
|
if err := deps.secretsBootstrap.load(deps.loadSecretsDir, deps.diagnostics); err != nil {
|
||||||
return "", nil, err
|
return "", nil, err
|
||||||
}
|
}
|
||||||
pipelineCfg, err := deps.loadPipelineConfig(resolvedPipelinePath, opts)
|
opts.Search = deps.pipelineSearch
|
||||||
|
pipelineCfg, err := deps.loadPipelineConfig(strings.TrimSpace(pipelineFlag), opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", nil, err
|
return "", nil, err
|
||||||
}
|
}
|
||||||
|
resolvedPipelinePath := config.EffectivePipelineRootPath(pipelineCfg)
|
||||||
|
if resolvedPipelinePath == "" {
|
||||||
|
resolvedPipelinePath = strings.TrimSpace(pipelineFlag)
|
||||||
|
}
|
||||||
return resolvedPipelinePath, pipelineCfg, nil
|
return resolvedPipelinePath, pipelineCfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func findRemoteSessionConfig(ctx context.Context, store storage.ObjectStore, sessionPrefix, remoteKey string) (storage.ObjectInfo, error) {
|
func findRemoteSessionConfig(ctx context.Context, store storage.ObjectStore, sessionPrefix, remoteKey, campaign, sessionID string) (storage.ObjectInfo, string, io.ReadCloser, error) {
|
||||||
objects, err := store.List(ctx, sessionPrefix)
|
authored, err := store.Exists(ctx, remoteKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return storage.ObjectInfo{}, fmt.Errorf("remote session %q list failed: %w", remoteKey, err)
|
return storage.ObjectInfo{}, "", nil, fmt.Errorf("check authored session %q: %w", remoteKey, err)
|
||||||
}
|
}
|
||||||
for _, obj := range objects {
|
var selected *artifacts.RemoteArtifact
|
||||||
if obj.Key == remoteKey {
|
if !authored {
|
||||||
return obj, nil
|
current, err := artifacts.LoadCurrentState(ctx, store, sessionPrefix, artifacts.CurrentStateValidation{ExpectedCampaign: campaign, ExpectedSessionID: sessionID, ValidateRunID: true})
|
||||||
|
if err == nil {
|
||||||
|
for _, item := range current.Commit.Artifacts {
|
||||||
|
if item.Type == artifacts.RemoteArtifactTypeRunFile && item.Source == "run:prepare/inputs/session.yml" {
|
||||||
|
identity, err := artifacts.ParseImmutableRunObjectKey(sessionPrefix, item.DestinationKey)
|
||||||
|
if err != nil || "run:"+identity.RelativePath != item.Source {
|
||||||
|
return storage.ObjectInfo{}, "", nil, fmt.Errorf("committed session source does not match its object key")
|
||||||
|
}
|
||||||
|
copy := item
|
||||||
|
selected = ©
|
||||||
|
remoteKey = item.DestinationKey
|
||||||
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return storage.ObjectInfo{}, fmt.Errorf("remote session %q not found", remoteKey)
|
} else if !errors.Is(err, artifacts.ErrCurrentCommitPointerMissing) {
|
||||||
|
return storage.ObjectInfo{}, "", nil, fmt.Errorf("load remote session selection: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
info, body, err := store.Read(ctx, remoteKey)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return storage.ObjectInfo{}, "", nil, fmt.Errorf("remote session %q not found: %w", remoteKey, err)
|
||||||
|
}
|
||||||
|
return storage.ObjectInfo{}, "", nil, fmt.Errorf("read remote session %q: %w", remoteKey, err)
|
||||||
|
}
|
||||||
|
if selected != nil {
|
||||||
|
if info.Size != selected.Size || strings.TrimSpace(info.ETag) != selected.Generation {
|
||||||
|
_ = body.Close()
|
||||||
|
return storage.ObjectInfo{}, "", nil, fmt.Errorf("remote session %q differs from committed object identity", remoteKey)
|
||||||
|
}
|
||||||
|
return info, selected.SHA256, body, nil
|
||||||
|
}
|
||||||
|
return info, "", body, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func s3BucketName(cfg *config.PipelineConfig) string {
|
func s3BucketName(cfg *config.PipelineConfig) string {
|
||||||
|
|||||||
40
internal/app/config_native_inspection_test.go
Normal file
40
internal/app/config_native_inspection_test.go
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConfigDiffUsesEscapedPointersAndAtomicLists(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
root := filepath.Join(dir, "pipeline.yml")
|
||||||
|
mustWriteTestFile(t, root, "whisperx: {transcribe_url: 'https://example.test/transcribe'}\nscriptorium:\n artifacts:\n recap:\n enabled: false\n output_path: artifacts/recap.md\n vars: {'a/b~c': before}\naudita: {modules: [glossary, grammar]}\n")
|
||||||
|
mustWriteTestFile(t, filepath.Join(dir, "overlays", "changed.yml"), "scriptorium:\n artifacts:\n recap:\n vars: {'a/b~c': after}\naudita: {modules: [glossary, homophones]}\n")
|
||||||
|
var output bytes.Buffer
|
||||||
|
if err := ConfigDiff(context.Background(), []string{"default", "changed", "--config", root}, &output); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, want := range []string{"changed\t/audita/modules\t[\"glossary\",\"grammar\"]\t[\"glossary\",\"homophones\"]", "changed\t/scriptorium/artifacts/recap/vars/a~1b~0c\t\"before\"\t\"after\""} {
|
||||||
|
if !strings.Contains(output.String(), want) {
|
||||||
|
t.Fatalf("diff lacks %q: %s", want, output.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigSourcesReportsEmptyOptionalImportAndNormalization(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
root := filepath.Join(dir, "pipeline.yml")
|
||||||
|
mustWriteTestFile(t, root, "config:\n imports:\n - path: absent.yml\nworkspace: {root: ./work}\nwhisperx: {transcribe_url: 'https://example.test/transcribe'}\n")
|
||||||
|
var output bytes.Buffer
|
||||||
|
if err := ConfigSources(context.Background(), []string{"--config", root}, &output); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, want := range []string{"empty_import\t/config/imports/0\tpath\t" + root, "workspace.root\tresolution\tresolution", "workspace.root\troot\t" + root} {
|
||||||
|
if !strings.Contains(output.String(), want) {
|
||||||
|
t.Fatalf("sources lack %q: %s", want, output.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -13,7 +13,6 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/adapters/notarius"
|
"gitea.maximumdirect.net/eric/narratio/internal/adapters/notarius"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/artifactmodel"
|
"gitea.maximumdirect.net/eric/narratio/internal/artifactmodel"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/artifactpolicy"
|
"gitea.maximumdirect.net/eric/narratio/internal/artifactpolicy"
|
||||||
@@ -21,6 +20,7 @@ import (
|
|||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/manifest"
|
"gitea.maximumdirect.net/eric/narratio/internal/manifest"
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/stage"
|
"gitea.maximumdirect.net/eric/narratio/internal/stage"
|
||||||
|
configkit "go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
type materializingNotariusRunner struct {
|
type materializingNotariusRunner struct {
|
||||||
@@ -314,7 +314,11 @@ characters:
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("ReadFile(prepared party) error = %v", err)
|
t.Fatalf("ReadFile(prepared party) error = %v", err)
|
||||||
}
|
}
|
||||||
if string(contents) != string(partyBytes) || partyPath == cfg.Party.Source.Path {
|
wantParty, err := partyDocument.YAML()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if string(contents) != string(wantParty) || partyPath == cfg.Party.Source.Path {
|
||||||
t.Fatalf("prepared party path=%q contents=%q source=%q", partyPath, contents, cfg.Party.Source.Path)
|
t.Fatalf("prepared party path=%q contents=%q source=%q", partyPath, contents, cfg.Party.Source.Path)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -691,17 +695,17 @@ func TestExtractLifecycleCredentialChangesRemainResumable(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestExtractLifecycleConfigProfileChangesRerunExtractionAndDependents(t *testing.T) {
|
func TestExtractLifecycleConfigOverlayChangesRerunExtractionAndDependents(t *testing.T) {
|
||||||
cfg, env, runner := extractionLifecycleFixture(t, true)
|
cfg, env, runner := extractionLifecycleFixture(t, true)
|
||||||
selected := "inexpensive"
|
selected := "inexpensive"
|
||||||
cfg.Pipeline.Notarius.ConfigProfile = &selected
|
cfg.Pipeline.Notarius.ConfigOverlay = &selected
|
||||||
analyzeRuns := 0
|
analyzeRuns := 0
|
||||||
plan := extractionLifecyclePlan(t, &analyzeRuns)
|
plan := extractionLifecyclePlan(t, &analyzeRuns)
|
||||||
|
|
||||||
if _, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env}); err != nil {
|
if _, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env}); err != nil {
|
||||||
t.Fatalf("initial executeStages() error = %v", err)
|
t.Fatalf("initial executeStages() error = %v", err)
|
||||||
}
|
}
|
||||||
if len(runner.requests) != 1 || runner.requests[0].ConfigProfile == nil || *runner.requests[0].ConfigProfile != selected || analyzeRuns != 1 {
|
if len(runner.requests) != 1 || runner.requests[0].ConfigOverlay == nil || *runner.requests[0].ConfigOverlay != selected || analyzeRuns != 1 {
|
||||||
t.Fatalf("initial requests=%#v analyze=%d, want selected extraction and analysis", runner.requests, analyzeRuns)
|
t.Fatalf("initial requests=%#v analyze=%d, want selected extraction and analysis", runner.requests, analyzeRuns)
|
||||||
}
|
}
|
||||||
reused, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env})
|
reused, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env})
|
||||||
@@ -721,12 +725,12 @@ func TestExtractLifecycleConfigProfileChangesRerunExtractionAndDependents(t *tes
|
|||||||
}
|
}
|
||||||
|
|
||||||
changed := "experimental"
|
changed := "experimental"
|
||||||
cfg.Pipeline.Notarius.ConfigProfile = &changed
|
cfg.Pipeline.Notarius.ConfigOverlay = &changed
|
||||||
rerun, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env})
|
rerun, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("changed-profile executeStages() error = %v", err)
|
t.Fatalf("changed-profile executeStages() error = %v", err)
|
||||||
}
|
}
|
||||||
if len(rerun.Executed) != 2 || len(runner.requests) != 2 || runner.requests[1].ConfigProfile == nil || *runner.requests[1].ConfigProfile != changed || analyzeRuns != 2 {
|
if len(rerun.Executed) != 2 || len(runner.requests) != 2 || runner.requests[1].ConfigOverlay == nil || *runner.requests[1].ConfigOverlay != changed || analyzeRuns != 2 {
|
||||||
t.Fatalf("changed-profile summary=%#v requests=%#v analyze=%d", rerun, runner.requests, analyzeRuns)
|
t.Fatalf("changed-profile summary=%#v requests=%#v analyze=%d", rerun, runner.requests, analyzeRuns)
|
||||||
}
|
}
|
||||||
after := loadLifecycleManifest(t, cfg)
|
after := loadLifecycleManifest(t, cfg)
|
||||||
@@ -741,12 +745,12 @@ func TestExtractLifecycleConfigProfileChangesRerunExtractionAndDependents(t *tes
|
|||||||
t.Fatalf("changed-profile lifecycle render=%#v analyze=%#v publish=%#v", after.Stages["render"], after.Stages["analyze"], after.Stages["publish"])
|
t.Fatalf("changed-profile lifecycle render=%#v analyze=%#v publish=%#v", after.Stages["render"], after.Stages["analyze"], after.Stages["publish"])
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg.Pipeline.Notarius.ConfigProfile = nil
|
cfg.Pipeline.Notarius.ConfigOverlay = nil
|
||||||
returned, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env})
|
returned, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("return-to-base executeStages() error = %v", err)
|
t.Fatalf("return-to-base executeStages() error = %v", err)
|
||||||
}
|
}
|
||||||
if len(returned.Executed) != 2 || len(runner.requests) != 3 || runner.requests[2].ConfigProfile != nil || analyzeRuns != 3 {
|
if len(returned.Executed) != 2 || len(runner.requests) != 3 || runner.requests[2].ConfigOverlay != nil || analyzeRuns != 3 {
|
||||||
t.Fatalf("return-to-base summary=%#v requests=%#v analyze=%d", returned, runner.requests, analyzeRuns)
|
t.Fatalf("return-to-base summary=%#v requests=%#v analyze=%d", returned, runner.requests, analyzeRuns)
|
||||||
}
|
}
|
||||||
final := loadLifecycleManifest(t, cfg)
|
final := loadLifecycleManifest(t, cfg)
|
||||||
@@ -755,10 +759,10 @@ func TestExtractLifecycleConfigProfileChangesRerunExtractionAndDependents(t *tes
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestExtractLifecycleConfigProfileFailureClearsCurrentResultAndDependents(t *testing.T) {
|
func TestExtractLifecycleConfigOverlayFailureClearsCurrentResultAndDependents(t *testing.T) {
|
||||||
cfg, env, runner := extractionLifecycleFixture(t, true)
|
cfg, env, runner := extractionLifecycleFixture(t, true)
|
||||||
selected := "inexpensive"
|
selected := "inexpensive"
|
||||||
cfg.Pipeline.Notarius.ConfigProfile = &selected
|
cfg.Pipeline.Notarius.ConfigOverlay = &selected
|
||||||
analyzeRuns := 0
|
analyzeRuns := 0
|
||||||
plan := extractionLifecyclePlan(t, &analyzeRuns)
|
plan := extractionLifecyclePlan(t, &analyzeRuns)
|
||||||
if _, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env}); err != nil {
|
if _, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env}); err != nil {
|
||||||
@@ -768,7 +772,7 @@ func TestExtractLifecycleConfigProfileFailureClearsCurrentResultAndDependents(t
|
|||||||
markLifecycleStageSucceeded(t, cfg, "publish")
|
markLifecycleStageSucceeded(t, cfg, "publish")
|
||||||
|
|
||||||
changed := "missing-profile"
|
changed := "missing-profile"
|
||||||
cfg.Pipeline.Notarius.ConfigProfile = &changed
|
cfg.Pipeline.Notarius.ConfigOverlay = &changed
|
||||||
runner.failuresRemaining = 1
|
runner.failuresRemaining = 1
|
||||||
if _, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env}); err == nil {
|
if _, err := executeStages(context.Background(), cfg, plan, RunOptions{Env: env}); err == nil {
|
||||||
t.Fatal("changed-profile executeStages() error = nil, want downstream failure")
|
t.Fatal("changed-profile executeStages() error = nil, want downstream failure")
|
||||||
@@ -783,12 +787,12 @@ func TestExtractLifecycleConfigProfileFailureClearsCurrentResultAndDependents(t
|
|||||||
t.Fatalf("failed changed-profile lifecycle trim=%#v render=%#v analyze=%#v publish=%#v analyzeRuns=%d",
|
t.Fatalf("failed changed-profile lifecycle trim=%#v render=%#v analyze=%#v publish=%#v analyzeRuns=%d",
|
||||||
failed.Stages["trim"], failed.Stages["render"], failed.Stages["analyze"], failed.Stages["publish"], analyzeRuns)
|
failed.Stages["trim"], failed.Stages["render"], failed.Stages["analyze"], failed.Stages["publish"], analyzeRuns)
|
||||||
}
|
}
|
||||||
if len(runner.requests) != 2 || runner.requests[1].ConfigProfile == nil || *runner.requests[1].ConfigProfile != changed {
|
if len(runner.requests) != 2 || runner.requests[1].ConfigOverlay == nil || *runner.requests[1].ConfigOverlay != changed {
|
||||||
t.Fatalf("failed request = %#v, want changed selector", runner.requests)
|
t.Fatalf("failed request = %#v, want changed selector", runner.requests)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestExtractLifecycleRealConfigProfilesSelectNotariusExplicitly(t *testing.T) {
|
func TestExtractLifecycleRealConfigOverlaysSelectNotariusExplicitly(t *testing.T) {
|
||||||
seed, env, runner := extractionLifecycleFixture(t, true)
|
seed, env, runner := extractionLifecycleFixture(t, true)
|
||||||
workspace := seed.Pipeline.Workspace.Root
|
workspace := seed.Pipeline.Workspace.Root
|
||||||
pipelinePath, campaignPath, sessionPath := writeValidConfigFiles(t, workspace)
|
pipelinePath, campaignPath, sessionPath := writeValidConfigFiles(t, workspace)
|
||||||
@@ -822,7 +826,7 @@ func TestExtractLifecycleRealConfigProfilesSelectNotariusExplicitly(t *testing.T
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
for name, contents := range map[string]string{
|
for name, contents := range map[string]string{
|
||||||
"testing": "whisperx:\n language: fr\nnotarius:\n config_profile: downstream-economy\n",
|
"testing": "whisperx:\n language: fr\nnotarius:\n config_overlay: downstream-economy\n",
|
||||||
"narratio-only": "whisperx:\n language: de\n",
|
"narratio-only": "whisperx:\n language: de\n",
|
||||||
"narratio-only-two": "whisperx:\n language: es\n",
|
"narratio-only-two": "whisperx:\n language: es\n",
|
||||||
} {
|
} {
|
||||||
@@ -848,7 +852,7 @@ func TestExtractLifecycleRealConfigProfilesSelectNotariusExplicitly(t *testing.T
|
|||||||
if _, err := executeStages(context.Background(), testingConfig, plan, RunOptions{Env: env}); err != nil {
|
if _, err := executeStages(context.Background(), testingConfig, plan, RunOptions{Env: env}); err != nil {
|
||||||
t.Fatalf("execute testing profile: %v", err)
|
t.Fatalf("execute testing profile: %v", err)
|
||||||
}
|
}
|
||||||
if len(runner.requests) != 1 || runner.requests[0].ConfigProfile == nil || *runner.requests[0].ConfigProfile != "downstream-economy" {
|
if len(runner.requests) != 1 || runner.requests[0].ConfigOverlay == nil || *runner.requests[0].ConfigOverlay != "downstream-economy" {
|
||||||
t.Fatalf("testing profile request = %#v, want explicit differently named downstream selector", runner.requests)
|
t.Fatalf("testing profile request = %#v, want explicit differently named downstream selector", runner.requests)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -857,7 +861,7 @@ func TestExtractLifecycleRealConfigProfilesSelectNotariusExplicitly(t *testing.T
|
|||||||
if _, err := executeStages(context.Background(), narratioOnly, plan, RunOptions{Env: env}); err != nil {
|
if _, err := executeStages(context.Background(), narratioOnly, plan, RunOptions{Env: env}); err != nil {
|
||||||
t.Fatalf("execute Narratio-only profile: %v", err)
|
t.Fatalf("execute Narratio-only profile: %v", err)
|
||||||
}
|
}
|
||||||
if len(runner.requests) != 2 || runner.requests[1].ConfigProfile != nil {
|
if len(runner.requests) != 2 || runner.requests[1].ConfigOverlay != nil {
|
||||||
t.Fatalf("Narratio-only profile request = %#v, want no automatic downstream selector", runner.requests)
|
t.Fatalf("Narratio-only profile request = %#v, want no automatic downstream selector", runner.requests)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ func addCommonConfigFlags(fs *flag.FlagSet, flags *commonConfigFlags) {
|
|||||||
flags.overlay.name = "overlay"
|
flags.overlay.name = "overlay"
|
||||||
fs.Var(&flags.overlay, "overlay", "named pipeline overlay")
|
fs.Var(&flags.overlay, "overlay", "named pipeline overlay")
|
||||||
flags.secretsDir.name = "secrets-dir"
|
flags.secretsDir.name = "secrets-dir"
|
||||||
fs.Var(&flags.secretsDir, "secrets-dir", "secrets directory (optional; defaults beside pipeline.yml)")
|
fs.Var(&flags.secretsDir, "secrets-dir", "secrets directory (optional; defaults to /usr/local/etc/narratio/secrets)")
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f commonConfigFlags) sessionOptions() config.SessionLoadOptions {
|
func (f commonConfigFlags) sessionOptions() config.SessionLoadOptions {
|
||||||
|
|||||||
@@ -164,7 +164,7 @@ func TestExecuteSessionInitRequiresSessionID(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestExecuteSessionInitMissingDefaultConfigReportsSearchedPaths(t *testing.T) {
|
func TestExecuteSessionInitMissingDefaultConfigReportsSearchedPaths(t *testing.T) {
|
||||||
deps, missingPath, executor := guardedMissingPipelineDiscovery(t)
|
deps, _, executor := guardedMissingPipelineDiscovery(t)
|
||||||
|
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
@@ -175,8 +175,7 @@ func TestExecuteSessionInitMissingDefaultConfigReportsSearchedPaths(t *testing.T
|
|||||||
if stdout.Len() != 0 {
|
if stdout.Len() != 0 {
|
||||||
t.Fatalf("stdout = %q, want empty", stdout.String())
|
t.Fatalf("stdout = %q, want empty", stdout.String())
|
||||||
}
|
}
|
||||||
if got := stderr.String(); !strings.Contains(got, "session init: no pipeline config path provided") ||
|
if got := stderr.String(); !strings.Contains(got, "source.missing") {
|
||||||
!strings.Contains(got, "no default pipeline config found") || !strings.Contains(got, missingPath) {
|
|
||||||
t.Fatalf("stderr = %q, want default pipeline searched-path error", stderr.String())
|
t.Fatalf("stderr = %q, want default pipeline searched-path error", stderr.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -203,7 +202,7 @@ func TestExecuteSessionInitRemoteLoadsSecretsBeforeObjectStoreInit(t *testing.T)
|
|||||||
|
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
code := executeWithDependencies([]string{"session", "init", "2026-06-07", "--remote"}, &stdout, &stderr, deps, executePlan)
|
code := executeWithDependencies([]string{"session", "init", "2026-06-07", "--remote", "--secrets-dir", secretsDir}, &stdout, &stderr, deps, executePlan)
|
||||||
if code != 0 {
|
if code != 0 {
|
||||||
t.Fatalf("exit code = %d, want 0; stderr=%q", code, stderr.String())
|
t.Fatalf("exit code = %d, want 0; stderr=%q", code, stderr.String())
|
||||||
}
|
}
|
||||||
@@ -242,22 +241,41 @@ inputs:
|
|||||||
t.Fatalf("read generated session: %v", err)
|
t.Fatalf("read generated session: %v", err)
|
||||||
}
|
}
|
||||||
got := string(data)
|
got := string(data)
|
||||||
for _, want := range []string{
|
generated, err := config.LoadSession(outputPath)
|
||||||
`session_id: "2026-06-07"`,
|
if err != nil {
|
||||||
`previous_session_id: "2026-05-31"`,
|
t.Fatal(err)
|
||||||
`date: "2026-06-07"`,
|
|
||||||
`title: "The Black Cabin"`,
|
|
||||||
`prefix: "audio/"`,
|
|
||||||
} {
|
|
||||||
if !strings.Contains(got, want) {
|
|
||||||
t.Fatalf("generated session = %q, want %q", got, want)
|
|
||||||
}
|
}
|
||||||
|
if generated.SessionID != "2026-06-07" || generated.PreviousSessionID != "2026-05-31" || generated.Date != "2026-06-07" || generated.Title != "The Black Cabin" || generated.Inputs.AudioS3 == nil || generated.Inputs.AudioS3.Prefix != "audio/" {
|
||||||
|
t.Fatalf("generated session = %#v", generated)
|
||||||
}
|
}
|
||||||
if strings.Contains(got, "{{") {
|
if strings.Contains(got, "{{") {
|
||||||
t.Fatalf("generated session still contains template placeholder: %q", got)
|
t.Fatalf("generated session still contains template placeholder: %q", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestExecuteSessionInitUsesImportedTemplateLocation(t *testing.T) {
|
||||||
|
pipeline, campaign, _ := writeValidConfigFiles(t, t.TempDir())
|
||||||
|
dir := filepath.Dir(campaign)
|
||||||
|
original, err := os.ReadFile(campaign)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
mustWriteTestFile(t, filepath.Join(dir, "fragments", "template-settings.yml"), "session_template_file: templates/session.yml\n")
|
||||||
|
mustWriteTestFile(t, filepath.Join(dir, "fragments", "templates", "session.yml"), "session_id: '{{ session_id }}'\ninputs:\n audio_s3: {prefix: audio/}\n")
|
||||||
|
if err := os.WriteFile(campaign, append([]byte("config:\n imports:\n - path: fragments/template-settings.yml\n"), original...), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
output := filepath.Join(t.TempDir(), "session.yml")
|
||||||
|
var stdout, stderr bytes.Buffer
|
||||||
|
if code := Execute([]string{"session", "init", "2026-06-07", "--config", pipeline, "--campaign-file", campaign, "--output", output}, &stdout, &stderr); code != 0 {
|
||||||
|
t.Fatalf("exit = %d; stderr = %q", code, stderr.String())
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(output)
|
||||||
|
if err != nil || !strings.Contains(string(data), "2026-06-07") {
|
||||||
|
t.Fatalf("generated session = %q, %v", data, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestExecuteSessionInitRemoteRendersCampaignTemplate(t *testing.T) {
|
func TestExecuteSessionInitRemoteRendersCampaignTemplate(t *testing.T) {
|
||||||
workspaceRoot := t.TempDir()
|
workspaceRoot := t.TempDir()
|
||||||
pipelinePath, campaignPath, _ := writeValidConfigFiles(t, workspaceRoot)
|
pipelinePath, campaignPath, _ := writeValidConfigFiles(t, workspaceRoot)
|
||||||
@@ -436,7 +454,7 @@ inputs:
|
|||||||
|
|
||||||
var stdout bytes.Buffer
|
var stdout bytes.Buffer
|
||||||
var stderr bytes.Buffer
|
var stderr bytes.Buffer
|
||||||
code := executeWithDependencies([]string{"session", "validate", "2026-05-03", "--config", pipelinePath, "--campaign-file", campaignPath, "--session", sessionPath}, &stdout, &stderr, deps, executePlan)
|
code := executeWithDependencies([]string{"session", "validate", "2026-05-03", "--config", pipelinePath, "--campaign-file", campaignPath, "--session", sessionPath, "--secrets-dir", secretsDir}, &stdout, &stderr, deps, executePlan)
|
||||||
if code != 0 {
|
if code != 0 {
|
||||||
t.Fatalf("exit code = %d, want 0; stdout=%q stderr=%q", code, stdout.String(), stderr.String())
|
t.Fatalf("exit code = %d, want 0; stdout=%q stderr=%q", code, stdout.String(), stderr.String())
|
||||||
}
|
}
|
||||||
@@ -800,11 +818,18 @@ func TestExecuteTopLevelLockAndUnlockAreRemoved(t *testing.T) {
|
|||||||
|
|
||||||
func withDefaultPipelineCampaignConfigs(t *testing.T, pipelinePath, campaignPath string) {
|
func withDefaultPipelineCampaignConfigs(t *testing.T, pipelinePath, campaignPath string) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
origPipelineDefaults := append([]string(nil), config.DefaultPipelineConfigSearchPaths...)
|
dir := t.TempDir()
|
||||||
config.DefaultPipelineConfigSearchPaths = []string{pipelinePath}
|
if err := os.Link(pipelinePath, filepath.Join(dir, "narratio.yml")); err != nil {
|
||||||
t.Cleanup(func() {
|
t.Fatal(err)
|
||||||
config.DefaultPipelineConfigSearchPaths = origPipelineDefaults
|
}
|
||||||
})
|
original, err := os.Getwd()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Chdir(dir); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { _ = os.Chdir(original) })
|
||||||
_ = campaignPath
|
_ = campaignPath
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ func sessionInitWithDependencies(ctx context.Context, args []string, out io.Writ
|
|||||||
overlay.name = "overlay"
|
overlay.name = "overlay"
|
||||||
fs.Var(&overlay, "overlay", "named pipeline overlay")
|
fs.Var(&overlay, "overlay", "named pipeline overlay")
|
||||||
secretsDir.name = "secrets-dir"
|
secretsDir.name = "secrets-dir"
|
||||||
fs.Var(&secretsDir, "secrets-dir", "secrets directory (optional; defaults beside pipeline.yml)")
|
fs.Var(&secretsDir, "secrets-dir", "secrets directory (optional; defaults to /usr/local/etc/narratio/secrets)")
|
||||||
fs.BoolVar(&remote, "remote", false, "write session.yml to S3 session prefix")
|
fs.BoolVar(&remote, "remote", false, "write session.yml to S3 session prefix")
|
||||||
fs.BoolVar(&force, "force", false, "overwrite existing target")
|
fs.BoolVar(&force, "force", false, "overwrite existing target")
|
||||||
if err := parseSessionAwareFlags("session init", fs, args, &sessionID); err != nil {
|
if err := parseSessionAwareFlags("session init", fs, args, &sessionID); err != nil {
|
||||||
@@ -58,6 +58,13 @@ func sessionInitWithDependencies(ctx context.Context, args []string, out io.Writ
|
|||||||
if strings.TrimSpace(audioDir) != "" && strings.TrimSpace(audioS3Prefix) != "" {
|
if strings.TrimSpace(audioDir) != "" && strings.TrimSpace(audioS3Prefix) != "" {
|
||||||
return fmt.Errorf("session init: --audio-dir and --audio-s3-prefix are mutually exclusive")
|
return fmt.Errorf("session init: --audio-dir and --audio-s3-prefix are mutually exclusive")
|
||||||
}
|
}
|
||||||
|
if strings.TrimSpace(audioDir) != "" {
|
||||||
|
var err error
|
||||||
|
audioDir, err = filepath.Abs(audioDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("session init: resolve --audio-dir: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
base, err := loadPipelineCampaignConfigWithDependencies(pipelinePath, campaignPath, campaignFilePath, config.PipelineLoadOptions{Overlay: overlay.pointer()}, secretsDir.pointer(), deps)
|
base, err := loadPipelineCampaignConfigWithDependencies(pipelinePath, campaignPath, campaignFilePath, config.PipelineLoadOptions{Overlay: overlay.pointer()}, secretsDir.pointer(), deps)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -83,7 +90,13 @@ func sessionInitWithDependencies(ctx context.Context, args []string, out io.Writ
|
|||||||
if label == "" {
|
if label == "" {
|
||||||
label = "remote session.yml"
|
label = "remote session.yml"
|
||||||
}
|
}
|
||||||
sessionCfg, err := config.LoadSessionBytesWithOptions(label, data, config.SessionLoadOptions{
|
// Generated defaults and CLI resources originate at the invocation. A
|
||||||
|
// configured template supplies its own existing local authoring context.
|
||||||
|
authoringPath := "session.yml"
|
||||||
|
if input.TemplateFile != "" {
|
||||||
|
authoringPath = resolveSessionInitTemplatePath(input.CampaignPath, input.TemplateFile)
|
||||||
|
}
|
||||||
|
sessionCfg, err := config.LoadSessionAuthoringBytes(authoringPath, data, config.SessionLoadOptions{
|
||||||
SessionID: sessionID,
|
SessionID: sessionID,
|
||||||
PreviousSessionID: previousSessionID,
|
PreviousSessionID: previousSessionID,
|
||||||
})
|
})
|
||||||
@@ -97,6 +110,10 @@ func sessionInitWithDependencies(ctx context.Context, args []string, out io.Writ
|
|||||||
if err := config.Validate(cfg); err != nil {
|
if err := config.Validate(cfg); err != nil {
|
||||||
return fmt.Errorf("session init: %w", err)
|
return fmt.Errorf("session init: %w", err)
|
||||||
}
|
}
|
||||||
|
data, err = config.RenderSessionDocument(cfg, sessionID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("session init: render effective session: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
if !remote {
|
if !remote {
|
||||||
if err := writeLocalFile(output, data, force); err != nil {
|
if err := writeLocalFile(output, data, force); err != nil {
|
||||||
|
|||||||
@@ -1,49 +0,0 @@
|
|||||||
package app
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
|
||||||
)
|
|
||||||
|
|
||||||
func resolvePipelineConfigPath(flagValue string) (string, error) {
|
|
||||||
return resolvePipelineConfigPathWithCandidates(flagValue, config.DefaultPipelineConfigSearchPaths)
|
|
||||||
}
|
|
||||||
|
|
||||||
func resolvePipelineConfigPathWithCandidates(flagValue string, candidates []string) (string, error) {
|
|
||||||
if explicit := strings.TrimSpace(flagValue); explicit != "" {
|
|
||||||
return explicit, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ordered := make([]string, 0, len(candidates))
|
|
||||||
for _, raw := range candidates {
|
|
||||||
path := strings.TrimSpace(raw)
|
|
||||||
if path == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
ordered = append(ordered, path)
|
|
||||||
info, err := os.Stat(path)
|
|
||||||
if err == nil {
|
|
||||||
if info.IsDir() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return filepath.Clean(path), nil
|
|
||||||
}
|
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return "", fmt.Errorf("check default pipeline config %q: %w", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(ordered) == 0 {
|
|
||||||
return "", fmt.Errorf("no pipeline config path provided and no default locations configured")
|
|
||||||
}
|
|
||||||
return "", fmt.Errorf(
|
|
||||||
"no pipeline config path provided and no default pipeline config found; searched: %s",
|
|
||||||
strings.Join(ordered, ", "),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -1,117 +0,0 @@
|
|||||||
package app
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestResolvePipelineConfigPathWithCandidatesExplicitWins(t *testing.T) {
|
|
||||||
got, err := resolvePipelineConfigPathWithCandidates(" ./custom/pipeline.yml ", []string{"/a", "/b"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolvePipelineConfigPathWithCandidates() error = %v", err)
|
|
||||||
}
|
|
||||||
if got != "./custom/pipeline.yml" {
|
|
||||||
t.Fatalf("resolved path = %q, want explicit path", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolvePipelineConfigPathWithCandidatesUsesFirstExisting(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
first := filepath.Join(dir, "first.yml")
|
|
||||||
second := filepath.Join(dir, "second.yml")
|
|
||||||
if err := os.WriteFile(second, []byte("workspace:\n root: ./tmp\n"), 0o644); err != nil {
|
|
||||||
t.Fatalf("write second default: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := resolvePipelineConfigPathWithCandidates("", []string{first, second})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolvePipelineConfigPathWithCandidates() error = %v", err)
|
|
||||||
}
|
|
||||||
if got != filepath.Clean(second) {
|
|
||||||
t.Fatalf("resolved path = %q, want %q", got, filepath.Clean(second))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolvePipelineConfigPathWithCandidatesPrecedence(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
first := filepath.Join(dir, "first.yml")
|
|
||||||
second := filepath.Join(dir, "second.yml")
|
|
||||||
if err := os.WriteFile(first, []byte("workspace:\n root: ./tmp\n"), 0o644); err != nil {
|
|
||||||
t.Fatalf("write first default: %v", err)
|
|
||||||
}
|
|
||||||
if err := os.WriteFile(second, []byte("workspace:\n root: ./tmp\n"), 0o644); err != nil {
|
|
||||||
t.Fatalf("write second default: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := resolvePipelineConfigPathWithCandidates("", []string{first, second})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolvePipelineConfigPathWithCandidates() error = %v", err)
|
|
||||||
}
|
|
||||||
if got != filepath.Clean(first) {
|
|
||||||
t.Fatalf("resolved path = %q, want first candidate %q", got, filepath.Clean(first))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolvePipelineConfigPathWithCandidatesMissing(t *testing.T) {
|
|
||||||
directory := t.TempDir()
|
|
||||||
first := filepath.Join(directory, "one.yml")
|
|
||||||
second := filepath.Join(directory, "two.yml")
|
|
||||||
_, err := resolvePipelineConfigPathWithCandidates("", []string{first, second})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "no default pipeline config found") {
|
|
||||||
t.Fatalf("error = %q, want missing-defaults context", err.Error())
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), first) || !strings.Contains(err.Error(), second) {
|
|
||||||
t.Fatalf("error = %q, want controlled searched paths", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestExecuteMissingExplicitConfigDiscoversExistingDefaultBeforeLoading(t *testing.T) {
|
|
||||||
directory := t.TempDir()
|
|
||||||
missing := filepath.Join(directory, "missing.yml")
|
|
||||||
existing := filepath.Join(directory, "pipeline.yml")
|
|
||||||
if err := os.WriteFile(existing, []byte("workspace:\n root: ./tmp\n"), 0o644); err != nil {
|
|
||||||
t.Fatalf("write default pipeline: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
controlledErr := errors.New("controlled pipeline loader boundary")
|
|
||||||
loadedPath := ""
|
|
||||||
deps := commandDependenciesForPipelineCandidates(missing, existing)
|
|
||||||
deps.loadPipelineConfig = func(path string, _ config.PipelineLoadOptions) (*config.PipelineConfig, error) {
|
|
||||||
loadedPath = path
|
|
||||||
return nil, controlledErr
|
|
||||||
}
|
|
||||||
deps.loadSecretsDir = func(string) (*configkit.SecretsReport, error) {
|
|
||||||
t.Fatal("absent conventional secrets directory unexpectedly invoked bootstrap loader")
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var stdout bytes.Buffer
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
code := executeWithDependencies([]string{"config", "validate"}, &stdout, &stderr, deps, func(context.Context, *config.Config, BoundedPlan, RunOptions) (*RunSummary, error) {
|
|
||||||
t.Fatal("config validation unexpectedly invoked pipeline executor")
|
|
||||||
return nil, nil
|
|
||||||
})
|
|
||||||
if code == 0 {
|
|
||||||
t.Fatal("exit code = 0, want controlled loader failure")
|
|
||||||
}
|
|
||||||
if loadedPath != existing {
|
|
||||||
t.Fatalf("loader path = %q, want discovered default %q", loadedPath, existing)
|
|
||||||
}
|
|
||||||
if stdout.Len() != 0 {
|
|
||||||
t.Fatalf("stdout = %q, want empty", stdout.String())
|
|
||||||
}
|
|
||||||
if !strings.Contains(stderr.String(), controlledErr.Error()) {
|
|
||||||
t.Fatalf("stderr = %q, want controlled loader error", stderr.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
153
internal/app/prepared_session_roundtrip_test.go
Normal file
153
internal/app/prepared_session_roundtrip_test.go
Normal file
@@ -0,0 +1,153 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/narratio/internal/adapters/storage"
|
||||||
|
"gitea.maximumdirect.net/eric/narratio/internal/artifacts"
|
||||||
|
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||||
|
"gitea.maximumdirect.net/eric/narratio/internal/manifest"
|
||||||
|
"gitea.maximumdirect.net/eric/narratio/internal/stage"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPreparedSessionPublishAndRemoteLoad(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
pipelinePath, campaignPath, sessionPath := writeValidConfigFiles(t, t.TempDir())
|
||||||
|
fragment := filepath.Join(filepath.Dir(sessionPath), "fragment.yml")
|
||||||
|
mustWriteTestFile(t, sessionPath, "config:\n imports:\n - path: fragment.yml\nsession_id: 2026-05-03\n")
|
||||||
|
mustWriteTestFile(t, fragment, "title: Published title\ninputs: {audio_dir: audio}\n")
|
||||||
|
cfg, err := config.LoadWithSessionOptions(pipelinePath, campaignPath, sessionPath, config.SessionLoadOptions{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
enabled := true
|
||||||
|
cfg.Pipeline.Publish.Enabled = &enabled
|
||||||
|
cfg.Pipeline.Publish.UploadRun = &enabled
|
||||||
|
cfg.Pipeline.Publish.Outputs = nil
|
||||||
|
fake := &storage.FakeBackend{}
|
||||||
|
store := artifacts.NewLocalStore(cfg.Pipeline.Workspace.Root)
|
||||||
|
env := &stage.Env{Config: cfg, ArtifactStore: store, ObjectStore: fake}
|
||||||
|
m := manifest.New("2026-05-03", time.Now().UTC())
|
||||||
|
m.Campaign = "sample-campaign"
|
||||||
|
m.RunID = "20260519T010203Z-a1b2c3d4"
|
||||||
|
runRoot := artifacts.SessionRunRootForCampaign(cfg.Pipeline.Workspace.Root, m.Campaign, m.SessionID, m.RunID)
|
||||||
|
m.LocalWorkDir = runRoot
|
||||||
|
if err := os.MkdirAll(runRoot, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
prepare, err := stage.Select("prepare")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := prepare.Run(ctx, env, m); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, name := range []string{"prepare", "transcribe", "merge", "polish", "normalize", "trim", "render", "analyze"} {
|
||||||
|
m.MarkStageSucceeded(name, time.Now().UTC(), nil)
|
||||||
|
}
|
||||||
|
if err := os.Remove(sessionPath); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Remove(fragment); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
publish, err := stage.Select("publish")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := publish.Run(ctx, env, m); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
prefix := artifacts.S3SessionPrefix("dnd", m.Campaign, m.SessionID)
|
||||||
|
key := artifacts.S3RunRelativeDestinationKey(artifacts.S3RunPrefix(prefix, m.RunID), "prepare/inputs/session.yml")
|
||||||
|
if got := string(fake.Objects[key].Data); !strings.Contains(got, "Published title") || strings.Contains(got, "imports:") || strings.Contains(got, "speakers_file:") {
|
||||||
|
t.Fatalf("published session = %q", got)
|
||||||
|
}
|
||||||
|
for _, name := range []string{"campaign.yml", "party.yml"} {
|
||||||
|
key := artifacts.S3RunRelativeDestinationKey(artifacts.S3RunPrefix(prefix, m.RunID), "prepare/inputs/"+name)
|
||||||
|
if data := fake.Objects[key].Data; len(data) == 0 || strings.Contains(string(data), "imports:") {
|
||||||
|
t.Fatalf("published %s = %q", name, data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
setSessionConfigSearchPaths(t, []string{sessionPath})
|
||||||
|
deps, _ := remoteSessionLoaderDependencies(fake)
|
||||||
|
loaded, err := loadCommandConfigWithDependencies(ctx, pipelinePath, "", campaignPath, "", config.SessionLoadOptions{SessionID: m.SessionID}, nil, deps)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = loaded.Close() }()
|
||||||
|
if loaded.Config.Session.Title != "Published title" || loaded.Config.SessionSource.S3Key != key {
|
||||||
|
t.Fatalf("remote session = %#v, source=%#v", loaded.Config.Session, loaded.Config.SessionSource)
|
||||||
|
}
|
||||||
|
if got := loaded.Config.StableInputs.SpeakersFile; got.Source != "campaign_config" || got.Path != filepath.Join(filepath.Dir(campaignPath), "speakers.yml") {
|
||||||
|
t.Fatalf("receiving campaign speakers = %#v", got)
|
||||||
|
}
|
||||||
|
current, err := discoverRemoteCurrentState(ctx, loaded.Config, fake)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
plan, err := buildRestorePlan(ctx, loaded.Config, current, fake, RestorePlanOptions{Force: true})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := map[string]bool{"inputs/session.yml": false, "inputs/campaign.yml": false, "inputs/party.yml": false}
|
||||||
|
for _, action := range plan.Actions {
|
||||||
|
if _, ok := want[action.LocalRelativePath]; ok {
|
||||||
|
want[action.LocalRelativePath] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for path, found := range want {
|
||||||
|
if !found {
|
||||||
|
t.Fatalf("restore omitted %q", path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
paths := store.SessionPathsFor(m.Campaign, m.SessionID)
|
||||||
|
for _, name := range []string{"session.yml", "campaign.yml", "party.yml"} {
|
||||||
|
if err := os.Remove(filepath.Join(paths.InputsDir, name)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var output strings.Builder
|
||||||
|
if err := restoreWithDependencies(ctx, []string{m.SessionID, "--config", pipelinePath, "--campaign-file", campaignPath, "--force"}, &output, deps); err != nil {
|
||||||
|
t.Fatalf("restore: %v", err)
|
||||||
|
}
|
||||||
|
restored, err := os.ReadFile(filepath.Join(paths.InputsDir, "session.yml"))
|
||||||
|
if err != nil || string(restored) != string(fake.Objects[key].Data) {
|
||||||
|
t.Fatalf("restored session = %q, %v", restored, err)
|
||||||
|
}
|
||||||
|
committedBytes := string(fake.Objects[key].Data)
|
||||||
|
if err := sessionInitWithDependencies(ctx, []string{m.SessionID, "--config", pipelinePath, "--campaign-file", campaignPath, "--remote", "--force", "--title", "Updated title", "--audio-s3-prefix", "replacement/"}, &output, deps); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
updated, err := loadCommandConfigWithDependencies(ctx, pipelinePath, "", campaignPath, "", config.SessionLoadOptions{SessionID: m.SessionID}, nil, deps)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = updated.Close() }()
|
||||||
|
if updated.Config.Session.Title != "Updated title" || updated.Config.Session.Inputs.AudioS3 == nil || updated.Config.Session.Inputs.AudioS3.Prefix != "replacement/" {
|
||||||
|
t.Fatalf("remote edit ignored: %#v", updated.Config.Session)
|
||||||
|
}
|
||||||
|
if string(fake.Objects[key].Data) != committedBytes {
|
||||||
|
t.Fatal("authoring update changed committed input")
|
||||||
|
}
|
||||||
|
if _, err := discoverRemoteCurrentState(ctx, updated.Config, fake); err != nil {
|
||||||
|
t.Fatalf("committed state after authoring update: %v", err)
|
||||||
|
}
|
||||||
|
// Remove the authored override to exercise committed-snapshot integrity below.
|
||||||
|
rootKey := artifacts.S3SessionConfigKey(prefix)
|
||||||
|
if err := fake.Delete(ctx, rootKey); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
object := fake.Objects[key]
|
||||||
|
modified := append([]byte(nil), object.Data...)
|
||||||
|
modified[0] ^= 1
|
||||||
|
fake.SeedObject(storage.FakeObject{Key: key, Data: modified, ETag: object.ETag})
|
||||||
|
if _, err := loadCommandConfigWithDependencies(ctx, pipelinePath, "", campaignPath, "", config.SessionLoadOptions{SessionID: m.SessionID}, nil, deps); err == nil || !strings.Contains(err.Error(), "committed checksum") {
|
||||||
|
t.Fatalf("changed remote session error = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -52,6 +52,18 @@ seriatim:
|
|||||||
audita:
|
audita:
|
||||||
binary: `+fixture+`
|
binary: `+fixture+`
|
||||||
credentials: [`+sharedProviderName+`, `+auditaOnlyName+`]
|
credentials: [`+sharedProviderName+`, `+auditaOnlyName+`]
|
||||||
|
scriptorium:
|
||||||
|
binary: `+fixture+`
|
||||||
|
credentials: [`+sharedProviderName+`]
|
||||||
|
render_debug: true
|
||||||
|
artifacts:
|
||||||
|
recap:
|
||||||
|
enabled: true
|
||||||
|
prompt_id: recap
|
||||||
|
output_path: artifacts/recap.md
|
||||||
|
inputs:
|
||||||
|
transcript:
|
||||||
|
source: narratio.transcript.final_trimmed
|
||||||
notarius:
|
notarius:
|
||||||
enabled: true
|
enabled: true
|
||||||
binary: `+fixture+`
|
binary: `+fixture+`
|
||||||
@@ -78,7 +90,7 @@ inputs:
|
|||||||
`)
|
`)
|
||||||
|
|
||||||
var stdout, stderr bytes.Buffer
|
var stdout, stderr bytes.Buffer
|
||||||
if code := Execute([]string{"config", "show", "--config", configPath}, &stdout, &stderr); code != 0 {
|
if code := Execute([]string{"config", "show", "--config", configPath, "--secrets-dir", secretsDir}, &stdout, &stderr); code != 0 {
|
||||||
t.Fatalf("config show exit = %d; stderr=%q", code, stderr.String())
|
t.Fatalf("config show exit = %d; stderr=%q", code, stderr.String())
|
||||||
}
|
}
|
||||||
if !strings.Contains(stdout.String(), sharedProviderName) || !strings.Contains(stdout.String(), auditaOnlyName) {
|
if !strings.Contains(stdout.String(), sharedProviderName) || !strings.Contains(stdout.String(), auditaOnlyName) {
|
||||||
@@ -92,7 +104,7 @@ inputs:
|
|||||||
mustWriteTestFile(t, basePath, `{"schema":"seriatim-intermediate","segments":[]}`)
|
mustWriteTestFile(t, basePath, `{"schema":"seriatim-intermediate","segments":[]}`)
|
||||||
seedCurrentBuiltInEvidence(t, manifestPath, "2026-05-03", "sample-campaign", "merge", artifacts.TranscriptOutputKindBase, artifacts.ArtifactTranscriptBase, basePath)
|
seedCurrentBuiltInEvidence(t, manifestPath, "2026-05-03", "sample-campaign", "merge", artifacts.TranscriptOutputKindBase, artifacts.ArtifactTranscriptBase, basePath)
|
||||||
mustWriteTestFile(t, filepath.Join(workRoot, "inputs", "glossary.yml"), "[]\n")
|
mustWriteTestFile(t, filepath.Join(workRoot, "inputs", "glossary.yml"), "[]\n")
|
||||||
args := []string{"--config", configPath, "--campaign-file", campaignPath, "--session", sessionPath}
|
args := []string{"--secrets-dir", secretsDir, "--config", configPath, "--campaign-file", campaignPath, "--session", sessionPath}
|
||||||
stdout.Reset()
|
stdout.Reset()
|
||||||
stderr.Reset()
|
stderr.Reset()
|
||||||
if code := Execute(append([]string{"run-stage", "polish", "2026-05-03", "--force"}, args...), &stdout, &stderr); code != 0 {
|
if code := Execute(append([]string{"run-stage", "polish", "2026-05-03", "--force"}, args...), &stdout, &stderr); code != 0 {
|
||||||
@@ -132,6 +144,12 @@ inputs:
|
|||||||
t.Fatalf("extract did not execute: %q", stdout.String())
|
t.Fatalf("extract did not execute: %q", stdout.String())
|
||||||
}
|
}
|
||||||
redactedLogs := 0
|
redactedLogs := 0
|
||||||
|
stdout.Reset()
|
||||||
|
stderr.Reset()
|
||||||
|
if code := Execute(append([]string{"analyze", "2026-05-03"}, args...), &stdout, &stderr); code != 0 {
|
||||||
|
t.Fatalf("analyze exit = %d; stderr=%q", code, stderr.String())
|
||||||
|
}
|
||||||
|
assertNoProviderValues(t, stdout.Bytes(), stderr.Bytes())
|
||||||
if err := filepath.WalkDir(workRoot, func(path string, entry os.DirEntry, walkErr error) error {
|
if err := filepath.WalkDir(workRoot, func(path string, entry os.DirEntry, walkErr error) error {
|
||||||
if walkErr != nil || entry.IsDir() {
|
if walkErr != nil || entry.IsDir() {
|
||||||
return walkErr
|
return walkErr
|
||||||
@@ -147,8 +165,8 @@ inputs:
|
|||||||
}); err != nil {
|
}); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if redactedLogs < 2 {
|
if redactedLogs < 4 {
|
||||||
t.Fatalf("redacted subprocess logs = %d, want Audita and Notarius", redactedLogs)
|
t.Fatalf("redacted subprocess logs = %d, want Audita, Notarius and Scriptorium run/render", redactedLogs)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -193,6 +211,24 @@ func TestProviderCredentialProcessFixture(t *testing.T) {
|
|||||||
_, _ = os.Stderr.WriteString("shared credential not forwarded\n")
|
_, _ = os.Stderr.WriteString("shared credential not forwarded\n")
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
}
|
}
|
||||||
|
if appSeriatimFlagValue(args, "--prompt") != "" {
|
||||||
|
if _, present := os.LookupEnv(auditaOnlyName); present {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
if appSeriatimFlagValue(args, "--api-key-env") != "" {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
output := appSeriatimFlagValue(args, "--out")
|
||||||
|
if err := os.MkdirAll(filepath.Dir(output), 0o755); err != nil {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(output, []byte("{}\n"), 0o644); err != nil {
|
||||||
|
os.Exit(2)
|
||||||
|
}
|
||||||
|
_, _ = os.Stdout.WriteString(sharedProviderKey + "\n")
|
||||||
|
_, _ = os.Stderr.WriteString(sharedProviderKey + "\n")
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
switch args[0] {
|
switch args[0] {
|
||||||
case "process":
|
case "process":
|
||||||
if os.Getenv(auditaOnlyName) != auditaOnlyKey {
|
if os.Getenv(auditaOnlyName) != auditaOnlyKey {
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user