Skip to main content

Module handoff

Module handoff 

Source
Expand description

speccoder pr: hands a feature’s work to review as a draft pull request whose body is the evidence behind every tick.

The one place speccoder talks to a git remote, and only when a person runs it and confirms (or passes --yes); without that it is a dry run that prints the body and the commands. It never merges, never marks the pull request ready, and pushes only speccoder/<feature>, the attestation notes (refs/notes/speccoder) and the held-out tests of the tasks closed on the pushed head (refs/speccoder/held-out/<unit>), none of them forced.

Structs§

PrOptions
How to hand off.

Constants§

BODY_LIMIT
GitHub’s cap on a pull request body, in characters.
EVIDENCE_CHECK_DOCS
Where the guidance to add the evidence check is.

Functions§

body
The pull request body: totals, a table of every task’s evidence, what is open, mutation results and tokens, and what verified does not mean.
bug_fixes
The issues the branch’s bug fixes close: a Fixes: #N trailer on a commit whose Bug: outcome is fixed, for a task of the status’s unit that is still verified or attested, or a trailer-only bug task (bugs/<slug>/bug:<slug>, which no task list holds). A task of another unit, or one the status does not list, closes nothing. Each issue once, in order.
evidence_workflow
The workflow under .github/workflows/ that runs speccoder-verify, if one does (repository-relative).
pr
speccoder pr.
tours
### Evidence tour: every tick’s tour, collapsed, as many as fit in room characters (dropped last-first, counted).
verify_section
How a reviewer checks the attestations themselves, when there are any. sigstore is the identity and issuer the project says sign: printed for the reviewer to confirm, never trusted on the project’s word.