openregs quarantine
Work the queue of documents a validation gate held for a person.
Triage the quarantine. Every document a validation gate refused waits here with its failure report and the snapshot it was made from; each item becomes a pull request on the regime repository, and a maintainer either fixes the mapper (and replays, so the fix reaches every snapshot it touches) or corrects the one document by hand under a human_authored override. Closing re-derives the answer rather than taking anybody’s word for it. The full workflow is docs/runbooks/quarantine-triage.md.
openregs quarantine [-h] --quarantine <path> <command> ...| Option | |
|---|---|
--quarantine <path> | the quarantine directory to work, as openregs ingest --quarantine filled it (required) |
openregs quarantine list
Section titled “openregs quarantine list”Show the queue: what is held, why, and who has claimed it.
openregs quarantine list [-h] [--closed]| Option | |
|---|---|
--closed | list resolved items instead — the record of what was done and why |
openregs quarantine claim
Section titled “openregs quarantine claim”Take an item, so two people do not fix the same thing twice.
openregs quarantine claim [-h] --by <who> [--at <rfc3339>] <item>| Argument | |
|---|---|
<item> | item directory name or doc id (required) |
| Option | |
|---|---|
--by <who> | who is taking it (required) |
--at <rfc3339> | record this instant instead of now |
openregs quarantine open
Section titled “openregs quarantine open”Publish an item as a pull request on the regime repository.
Commit the item and a request body naming the failing gate, the mapping report and the snapshot sha256 to a branch of the regime repository, and push it. There is no forge here and none is needed: a pull request is a branch on a remote plus a request body, and a maintainer merges the branch when the item closes.
openregs quarantine open [-h] [--remote <path-or-url>] [--base <branch>] [--branch <name>] [--by <who>] [--at <rfc3339>] [--dry-run] <item>| Argument | |
|---|---|
<item> | item directory name or doc id (required) |
| Option | |
|---|---|
--remote <path-or-url> | the regime repository to open the request on |
--base <branch> | branch the request is against (default main) |
--branch <name> | branch to push (default: quarantine/<item>) |
--by <who> | author the triage commit is made under |
--at <rfc3339> | record this instant instead of now |
--dry-run | print the request body and push nothing |
openregs quarantine annotate
Section titled “openregs quarantine annotate”Admit a hand-corrected document under a human_authored override.
Write a corrected Akoma Ntoso document into the canon on a person’s authority, recording method: human_authored and their name in every unit’s metadata. The one way into the canon that does not go through the four gates, for the one case they cannot answer: a defect in the document itself, which no mapper can repair.
openregs quarantine annotate [-h] --akn <path> --by <who> --canon <path> <item>| Argument | |
|---|---|
<item> | item directory name or doc id (required) |
| Option | |
|---|---|
--akn <path> | the corrected Akoma Ntoso document for this capture (required) |
--by <who> | who is answering for this text (required) |
--canon <path> | the canon the corrected units are written into (required) |
openregs quarantine close
Section titled “openregs quarantine close”Close items that verify, by re-deriving the answer.
An item closes on evidence: the canon holds hand-authored units traceable to its snapshot, or the archived snapshot re-mapped by the transform as it stands now passes all four gates and the canon holds what it produced. Neither, and the item stays open with the reason printed.
openregs quarantine close [-h] [--all] [--canon <path>] [--state-dir <path>] [--config <path>] [--by <who>] [--at <rfc3339>] [--no-push] [<item>]| Argument | |
|---|---|
<item> | item directory name or doc id |
| Option | |
|---|---|
--all | sweep the whole queue, closing every item that verifies |
--canon <path> | the canon to check against |
--state-dir <path> | read the snapshot store under here instead of state/ |
--config <path> | read gate thresholds from this configuration instead of config/sources.yaml |
--by <who> | who is closing it |
--at <rfc3339> | record this instant instead of now |
--no-push | do not carry the resolution onto the item’s pull request branch |
Rendered from openregs/openregs@cbe9615:tooling/openregs/cli/main.py