Expand description
The speccoder / evidence check run, rendered from a branch report:
the verdict bar and the trust it used (summary), the requirement trace,
every tick and its tour (text), and one annotation per tick that is not
plainly verified, on the line it is about. The same, as workflow
commands and a step summary, where the check cannot be published.
Rendering only: the report decides, these words never soften it.
Structs§
- Annotation
- One annotation, in GitHub’s check-run shape.
Constants§
- ANNOTATIONS_
PER_ REQUEST - Annotations GitHub takes per check-run request.
- NAME
- The check run’s name.
- TEXT_
BUDGET - Characters GitHub takes in a check run’s
summary, and in itstext.
Functions§
- annotations
- One annotation per tick that is not plainly verified: unverifiable and
regressed as
failure, regression-only and stale aswarning(stale on the changed requirement’s line), attested as anoticenaming who accepted it. - bar
- The verdict bar, its first line: the counts in the verdict words.
- markdown
- The whole check as Markdown: summary, then text (the job summary, the
--markdownfile). - published
- The conclusion a check run is published with: GitHub counts a
neutralrequired check as passing, so neutral isfailureunless the maintainer allows it. - request
- The check-run request bodies,
{ "create": …, "updates": [ … ] }: at most 50 annotations in the create, the rest in updates of 50. - summary
- The check run’s
summary: the bar, the trust, and what this verifier did not evaluate or show. - text
- The check run’s
text: the tables, then each tour collapsed, tours dropped last-first with a counted line when over budget. Returns how many tours were not shown. - workflow_
commands - The fallback: the annotations as workflow commands, at most 10 of a kind, then a notice counting the rest.