Skip to content

toolroom.goldens

Render the golden records, the golden stubs and the records' schema.

A golden is a small record shaped to exercise the renderer, and its stub at every version is checked in, rendered as a consumer renders the version it locks. The test compares each render with its golden byte for byte, so a change to the renderer fails the gate until this verb moves the goldens in the same change, which is what keeps a render change deliberate. records/record.schema.json is the same kind of file, exported from the record's shape and compared by a test, so it moves here too. --check names what would move and writes nothing.

fm toolroom.goldens [--check]
Parameter Type Default Description
--check flag false report what differs instead of writing

Returns: a mapping of lists of text

Example

$ fm toolroom.goldens --check