Skip to main content

Module e2e

Module e2e 

Source
Expand description

e2e attest / e2e verify — the e2e decision nudge. attest records the runner’s chosen command as a branch-keyed receipt; verify confirms a branch changing scoped source has one.

Structs§

Attestation
A record of one e2e decision, written to RECEIPTS_DIR/<branch_slug>.json. Everything here is for humans — verify reads only the receipt’s presence in the branch’s diff.

Enums§

Verification
The outcome of verify — whether a committed receipt answers the branch’s e2e nudge.

Constants§

RECEIPTS_DIR
Where the branch-keyed receipts live, relative to the package root: <branch_slug>.json.

Functions§

attest
Run command in repo and, when it passes, write and commit the branch’s receipt at repo/RECEIPTS_DIR/<branch_slug>.json. A non-zero command leaves the receipts untouched; the returned Attestation::exit_code carries the failure either way.
branch_slug
The standardized receipt slug for a branch name — the receipt lives at e2e-attestations/<slug>.json. Lowercased; every character outside [a-z0-9._-] becomes -; runs collapse; truncated to 80; edges trimmed; an empty result falls back to branch.
verify
Verify the e2e decision at repo — the CI side of the nudge. Equivalent to verify_scoped with scope set to repo.
verify_extra_scoped
Verify the e2e decision at repo, joining extra scopes outside scope into what counts as scoped source and subtracting excludes. With base, both checks are content diffs of <base>...HEAD; without one, a committed receipt at repo is the whole check.
verify_scoped
Verify the e2e decision at repo, with scope (rather than all of repo) defining what counts as scoped source; scope must be repo or a descendant. Equivalent to verify_since with no base.
verify_since
Equivalent to verify_extra_scoped with no extra roots and no excludes.