Skip to content

v0.95.0

Choose a tag to compare

@robertblust robertblust released this 27 Oct 04:59
· 28 commits to main since this release
0ac1a6a

A requirement and a use case can say how far they are realized (#364): the levels an instance defines, the evidence that shows each page has reached its level, and one check that holds the two together. Core and the four packs' manifests move to 0.70.0, and the package moves to 0.95.0 with both reusable workflows' refs.

  • requirement-realization and use-case-realization are types of the requirements pack: an ordered set of levels the instance defines, one file each in requirement-realizations/ and use-case-realizations/, in the shape of core's decision status. Each level has a rank for its order and an evidence of none, satisfies or verifies for what a page at it must show.
  • A requirement and a use case may name their level in realization, say in ## Realization what is realized and what is missing, measured against the fit criterion or the scenario and its guarantees, and list in ## Evidence the rows that show it, each with Shows as satisfies (it builds it) or verifies (it observes what the fit criterion observes), and a URL pinned to a commit.
  • A new row key, evidenced, drives one check (R16): a page at a level asking satisfies has at least one Evidence row, one at a level asking verifies has a row that verifies, a page naming a level has ## Realization, and a page with either section names a level. A level that names nothing, an evidence or Shows value off its tokens and an Evidence table with other columns are left to the checks that already report them.
  • It is a realization, not a status: the requirement schema's rule against a status, priority, release or date on the page stays, and names the realization as the one value that moves, held to its evidence. A test that verifies a requirement goes in ## Evidence once the page names a realization, and in ## References otherwise.
  • The example defines levels for both types: its requirement is Built, and Download an invoice stands at Main scenario runs, built with one extension still missing.

What breaks. For an instance, nothing: every field and section is optional, core's schemas are unchanged, and an instance that defines no levels passes as before. For a consumer of ./checks, TypeEntry gains an optional evidenced key, which breaks no reader or writer.

How to take it. Move the pin to v0.95.0 and run companygraph upgrade, which moves the vendored core and packs to 0.70.0. An instance taking the requirements pack that tracks how far its requirements are built writes its levels into requirement-realizations/ or use-case-realizations/, then names them on the pages.

Verified: npm run verify with its release check, typecheck, build:check and every test:* script pass, as do conventions-format and conventions-check; companygraph, robertblust and guestgraph mental-model, cloned at their main commits and upgraded with this checkout's CLI, go to core 0.70.0, pass check, and find nothing to do on a second upgrade.