feat: scaffold-verifier + explain operator commands, outcome epilogues, run social card - #388
Merged
Merged
Conversation
…ogues, and run social card Two read-first operator helpers close the 'what do I do next' gap after a run ends without a receipt: - flow scaffold-verifier <recording|bundle>: drafts (never approves) an effect-oracle contract (effect_contract.yaml) from the demonstration's retained write-shaped evidence -- observed system-of-record deltas split identity from payload exactly as compiler.effect_mining does; every observed value carries a TODO; a deployment effects: skeleton matches docs/EFFECT_KIT.md. Refuses demonstrations with no consequential step. - flow explain <run-dir>: pure read-only plain-language outcome summary (what happened / which check fired for a HALT / the exact next command). - outcome-aware 3-line epilogues on non-VERIFIED replay endings, failing lint, and non-VERIFIED tutorial runs: presentation only, fail-closed semantics and exit codes untouched. - scripts/social_card.py: deterministic PHI-free PNG share card from a run's report.json (+receipt.json/bench.json when present); no network, PIL default fonts only. Existing subcommands are unchanged (parser choices diff: only the two additions).
abrichr
force-pushed
the
growth/operator-tooling
branch
from
August 22, 2026 21:45
18c23b2 to
f567a28
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two read-first operator helpers plus outcome-aware endings, from the growth/operator-tooling lane.
flow scaffold-verifier <recording|bundle>(new): reads retained action/effect evidence and emits a DRAFT effect-oracle contract (effect_contract.yaml) pre-filled from write-shaped steps — proposed system-of-record read (matchselector), expected postcondition fields with explicitTODOmarkers, observed idempotency key, and adeployment.effects:skeleton matchingdocs/EFFECT_KIT.md/RestRecordVerifierconventions. Identity-vs-payload splitting reusescompiler.effect_mininghelpers so drafts match real mined contracts. Explicitly a draft: loud requires-human-edit header, nothing auto-approved, and a demonstration with no consequential step is REFUSED.flow explain <run-dir>(new): pure read-only plain-language summary of a completed run dir — what happened, why the outcome is the safe one (names the exact check that fired for a HALT: refuted effect / identity mismatch / failed postcondition), and the suggested next command (re-run, pair an oracle via scaffold-verifier, or qualify init).scripts/social_card.py <run-dir> -o card.png(new): deterministic PHI-free share card fromreport.json(+receipt.json/bench.jsonwhen present): status badge (VERIFIED green / otherwise amber), workflow name, duration median, trials, model-calls line, short artifact SHA-256 footer, openadapt.ai URL. No network; PIL default fonts; ASCII-only glyphs.Files changed
openadapt_flow/scaffold_verifier.py(new)openadapt_flow/__main__.py(additive subcommand registration + epilogue hooks only)openadapt_flow/tutorial.py(epilogue text helpers)scripts/social_card.py(new)tests/test_scaffold_verifier.py,tests/test_outcome_epilogues.py(new)README.md, _browser_setup.py, and scripts/install.sh are untouched (owned by another lane).
Verification
ruff check+ruff format --check(pinned 0.16.3) clean on all changed filesmypy: new modules clean; repo-wide error count identical to mainopenadapt_types,benchmark.*shadowing)python -m openadapt_flow --helplists both new commands; parser choices diff vs main is exactly{scaffold-verifier, explain}added, nothing removedRisks / notes
{param: name}flow mappings for parameter bindings, mirroring the deployment.yaml conventions in docs/EFFECT_KIT.md.