chore: pre-release fixes and documentation for 0.28.0 - #948
Merged
Conversation
…epare-source `evidencectl source add` reviews the connection it would make and applies it only with `--apply`; `--dry-run` and the interactive confirmation are gone. `bregctl dev prepare-source` stays runnable but leaves `bregctl dev --help`, because `source add` is the documented local BReg-to-Evidence path. Registry starters ship `core/dev-clients.yaml`, the file a first `bregctl dev` reads without `--clients-file`. The composition check in CI exercises the review path, and the BReg evidence starter READMEs describe the same flow. Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Root AGENTS.md maps the seven crates it omitted and states both directions of the BReg and Evidence composition: a governed action as an Evidence relying party, and `evidencectl source add` driving `bregctl` on PATH with no crate dependency either way. products/breg records the 0.28.0 decisions (the unconditional Evidence dependency, the 24 h retention with operator-run erasure) and brings IMPLEMENTATION, the Definition of Done and its contract, and ACCEPTANCE-JOURNEYS in line with the shipped governed actions, native patterns, membership boundaries, model derivation, starters, and dev lifecycle. external/README.md carries the PublicSchema snapshot reachability caution, behavioral-guarantee-claims.md pins its 13 links to v0.19.0, and the Evidence CONFIG.md states the baseUrl constraint the runtime enforces. Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Stamp `cli-reference.yaml` current at workspace version 0.27.0 so the 135 generated CLI pages publish, and seat every published command page in the sidebar in command order. `npm run cli-reference:digest` prints the two values the record carries; docs/site/AGENTS.md and release/OPERATIONS.md require a re-stamp in the same change as any clap or workspace version change, because the generator refuses a build whose digest differs from the record. Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Add explanation pages for governed registry actions, native field patterns, and membership read boundaries, adapted from products/breg; document `bregctl evidence-retention erase-expired` and the 24 h Evidence-use retention scope on the retention page; rewrite the Unreleased changelog section with the breaking `bregctl dev` positional project; advance the v0.21.0 pins on the operations and Mint pages to v0.26.1; and update the Evidence-from-BReg tutorial to the report-then-`--apply` flow. Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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
Content fixes from the v0.27.0..main pre-release review, ahead of the 0.28.0 release. This PR does not bump the version, write release notes, or touch the release manifest; a separate release PR does that on top of this one.
Decisions applied (recorded in
products/breg/DECISIONS.md):registry-bregkeeps its unconditional dependency onregistry-evidence-clientandregistry-evidence-verifier; both composition directions are stated in rootAGENTS.md; feature gate ticketed (Feature-gate the Evidence relying-party dependency in registry-breg #930).bregctl evidence-retention erase-expired; scope documented on the retention operate page; configurable retention ticketed (Evidence-use retention: configurable duration, digest-only mode, in-process sweeper #931).bregctl dev --projectreplaced by a positional project).docs/site/src/data/cli-reference.yamltocurrent; the re-stamp rule is written indocs/site/AGENTS.md, rootAGENTS.md, andrelease/OPERATIONS.md.evidencectl source addis the documented local BReg-to-Evidence path;bregctl dev prepare-sourceis hidden from help but stays runnable; the three Evidence starter READMEs converge onsource add; quickstart retirement ticketed (Retire products/breg/quickstart in favour of bregctl dev #935).core/dev-clients.yaml;source addpreviews by default and performs with--apply, no--dry-run, no confirmation prompt); released flag inconsistencies ticketed as one batch (CLI consistency batch across bregctl and evidencectl #934).registry-extensibility.md,native-patterns.md, andmembership-access.mdfromproducts/bregadapted into three site explanation pages; tutorials ticketed (Publish the BReg-to-Evidence tutorials on evidencectl source add #939, Rebuild review-registry-changes and first-breg on bregctl init, dev and examples #941).Commits
feat(evidence): preview source add by default and hide bregctl dev prepare-source:source_add.rs,source_cli.rs,bregctldev/mod.rs(hide = true), tests,verify-composition.pyreview-path coverage, CI comment, starterclients.yamltodev-clients.yamlrenames, BReg evidence READMEs,DEV.md,EVIDENCE.md.docs(breg): record composition boundaries and align product contracts: rootAGENTS.md(seven map rows, composition paragraphs, generated-outputs rule),products/bregAGENTS, README, DECISIONS, IMPLEMENTATION (W5 capability table), DEFINITION-OF-DONE andcontracts/definition-of-done.yaml(nine rows), ACCEPTANCE-JOURNEYS (fifteen projects),external/README.md,release/notes/behavioral-guarantee-claims.md(thirteen links pinned to v0.19.0), Evidence deploymentCONFIG.md(sourceConnections.*.baseUrlrow).docs(site): publish the CLI reference and add the re-stamp rule:cli-reference.yamlstamped at 0.27.0,cli-reference-digest.mjsandnpm run cli-reference:digest, sidebar seats for every published command page, tests,docs/site/AGENTS.md,release/OPERATIONS.md.docs(site): describe the unreleased BReg and Evidence changes: three explanation pages, retention page section, changelog Unreleased rewrite, pin advances v0.21.0 to v0.26.1, Evidence-from-BReg tutorial, sidebar and information-architecture test entries.Security-sensitive review notes
evidencectl source addbehavior change: the command now applies nothing unless--applyis passed. The interactive confirmation is removed; the entity, field, facts, and scope prompts remain when omitted in a terminal. The JSON report carriesstatus: "preview"with anextsentence. Testevery_bregctl_invocation_names_the_public_flags_source_add_declaresandverify_source_add_reviewinverify-composition.pycover it.AGENTS.md,products/breg/AGENTS.md): a governed action is an Evidence relying party and inherits no Evidence authorization;source adddrivesbregctlon PATH and neither product depends on the other's tooling crate.erase-expireddeletes assertion bytes and verification context; receipts stay replayable. Wording is the command's help text.Judgment calls worth a look
cli-reference-sidebar.mjsnow walks the generated tree and seats them in one flat collapsedCLI commandsgroup, labeled by full command path (bregctl audit export). Flat becauselimitSidebarDepthflattens below the second level anyway; nested groups would render the same with ambiguous labels.BREG-V1-ACTION-HANDLERS), the precedent set byBREG-V1-PILOT, sovalidate_product.pyneeded no change.BREG-V1-ACTION-EVIDENCE-TRIALandBREG-V1-EVIDENCE-RETENTIONare the firstpartialrows; the journey mappings are best fit, not derived from the matrix.products/breg/evidence/starter/README.mdkeeps its manual export path besidesource add:source add --applycreates the Evidence project itself, refuses a settings-onlytargets/local, and exposes one selector, so the plain starter's teaching flow needs the hand path.source addpoint attutorials/first-bregbecause the two Evidence-from-BReg tutorials are stilldraft: true(Publish the BReg-to-Evidence tutorials on evidencectl source add #939).Gates run
Rust (worktree,
--locked):cargo fmt --check,cargo check --workspace --all-targets, clippy with-D warningsand tests forregistry-evidencectlandregistry-bregctl,products/evidence/scripts/check-contracts.sh,check-source-neutrality.sh,products/breg/scripts/check_source_neutrality.py, the non-liveverify-composition.pypath CI runs.Products:
validate_product.pyand theproducts/bregunittests pass with the nine DoD rows.Docs site:
npm test554 pass;npm run checkexit 0 (check-llms 336 passed, SEO check passed, built link check 90388 internal links);npm run check:cli-referenceexit 0; vale 0 errors on every changed or created page.Left for the release PR
cli-reference.yaml:npm run cli-reference:digestfromdocs/site, record both values and a freshlast_reviewed. The docs build refuses the release tree otherwise.tutorials/query-relay-client.mdx:249andtutorials/itb-semic-evidence.mdx:34-35(v0.20.0),reference/errors.mdx:147andreference/apis/index.mdx:48(v0.21.0),operate/breg.mdx:83(bregctl 0.26.1, the majority pin on that page).Out of scope, noted
crates/registry-bregctl/src/init_from_model/render.rs:1211: the generated project README still points readers at the hiddenbregctl dev prepare-source.products/breg/evidence/README.md:52still documents--clients-file ./registry/clients.yamlfor the copied fixture registry; that fixture was deliberately not renamed.Follow-up tickets filed
#930 #931 #932 #933 #934 #935 #936 #937 #938 #939 #940 #941 #942 #943 #944 #945 #946 #947