Module committed

Expand description

The committed reports, held to a run and to the accepted census: the check cargo xtask validate --check makes.

check takes a run of every case (crate::run_lock) and fails unless

every scored metric is within its tolerance;
the run reproduces the committed report, validation/reports/latest.{md,json}, to the digits the platforms share (Report::reproduces); and
the committed reports hold to the accepted census, validation/reports/census.json, and every file written from it is what it writes (check_census; the census’s decision record, ADR-084).

The census is checked whether or not the run reproduces, so a report that fails both says so.

Structs§

BADGES: Where the badges go.
BEGIN: The line that opens the census table in each of TABLES.
CENSUS_JSON: The accepted census.
CENSUS_MD: Its page.
CENSUS_MISSING_HINT: What to do when the accepted census is missing: the hint that ends that refusal’s message.
CENSUS_URL: Its page on GitHub, which the tables link to: the README and the site read it at one address.
END: The line that closes it.
LATEST_JSON: The harness’s committed report, JSON.
LATEST_MD: The harness’s committed report, Markdown.
REPORT_HINT: What to do when the committed report is not this run’s.
TABLES: The files that show the census table, between BEGIN and END.

census_changes: The differences between the committed reports and the accepted census; every row is added when none is accepted yet.
census_outputs: Every file the accepted census writes, with its text, by its path from root.
change_lines: A line per change, and a summary: what cargo xtask census prints.
check: Holds report, a run of every case, to the reports committed under root.
check_census: The committed reports under root against the accepted census, and the files written from it.
read_accepted: The accepted census, or None if none is committed.
splice: text with what lies from BEGIN to END replaced by block.
stale: The outputs whose committed text, as read gives it, isn’t what the census writes.
take_census: The census of the reports committed under root.