Repository navigation
docs: Describe the shapes of basou board (board.yaml, the record's input, records and the measurement) - #370
Merged
Conversation
…put, records and the measurement) docs/spec/board.md describes the shapes basou board reads and writes, as of board_version 3 and record_version 3: every key of board.yaml with what is required and its default, the rules of each kind of measure (the files a measure of a repo sees, the glob dialect, regular expressions matched line by line, when a value is null) and of each kind of observation (the value the guide asks for, the http value and its nulls), the registry of components and the built-in markers, the input basou board record reads and the order it is checked in, a record's keys and the declaration it keeps, every section of the measurement with what each null means, what the difference from the previous record compares, what the digest covers, and how a record of version 1 or 2 differs. The page says at its top that these shapes are outside every guarantee, as the command is, and may change at any release. compatibility.md's list of experimental commands, cli-commands.md and docs/README.md point to it, and the changelog's Unreleased section says it was added.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/spec/board.md, a reference for the shapes the experimentalbasou boardreads and writes, as shipped in 0.71.0 (board_version3,record_version3):board.yaml: how it is read, every top-level key with what is required and its default, the stages and lanes, each of the ten kinds of measure (the files a measure of a repo sees, the glob dialect, regular expressions matched line by line, when a value is null), ratios, each of the nine kinds of observation with the value the guide asks for (thehttpvalue and its nulls included), the registry of components with the built-in markers andmarker, the axis and the effort.basou board record: its keys, the order it is checked in,observed,cells,prose,judged_by,axis_review, and what--jsonprints.not_foundplaces, the methods, the difference from the previous record, and exactly what the digest covers.docs/spec/compatibility.md(under the list of experimental commands),docs/spec/cli-commands.mdanddocs/README.mdpoint to it, andCHANGELOG.mdgets an entry under## Unreleased.Why
Until now these shapes were described only in the changelog, in
--helpand in whatbasou board guideprints, so a board was declared by trial and error against the refusals ofbasou board measure. The page says at its top that every shape on it is outside every guarantee, as the command is, and may change at any release.How it was checked
2c60650(packages/core/src/board/,packages/cli/src/commands/board.ts).board.yamlexample and record input example were run throughparseBoardDeclarationandparseRecordInputof the built@basou/core; both read.board_version, a version 3 kind in a version 2 board, agroupwithout apattern, anobserved_atwithout an offset, and others) were reproduced against the same build.diffplaces it lists were compared with a realbasou board measure --json.experimental.test.ts(which reads the table in compatibility.md), the CHANGELOG history guard, biome, the planning-identifier and absolute-path scans pass locally.