# What wai-conformance.yml runs, one file a step

`wai-conformance.yml` keeps no hand list of its verifier steps, corpora or kernel tests. Its
lists are derived, when it runs, from the files here and from tags in the test files, by
[`scripts/wai-conformance-lists.py`](../../scripts/wai-conformance-lists.py), whose
docstring states every key; its gate reads the steps' `paths:` through
`scripts/pr-touches-paths.py`. A change that adds a verifier, a corpus or a kernel test adds
a file, or a line to a file of its own, and edits no line of the workflow, unless a step's
`paths:` names a file under none of the trigger's paths (`check` names it). Its features and
`[[test]]` entries in `wai/wai-rs/Cargo.toml` stay shared
([`wai/CONTRIBUTING.md`](../../wai/CONTRIBUTING.md)).

- `verifiers/<name>.sh`: one step of the `independent-verifiers` job. Its body is the step's
  shell, run in `wai/` (or `working-directory:`) with `bash -eo pipefail`, as a workflow step
  runs. Its header, the leading `# key: value` lines, gives `step:` (its name), `order:` (steps
  run in ascending order, a tie by file name), `features:` (each list compiles alone in
  `features-alone`, and every feature joins `WAI_FEATURES`), and where it needs them `alone:`,
  `build: pq`, `release-features:`, `bins:`, `pq-bins:`, `paths:` (the extension texts it
  reads, which the workflow's gate then runs on) and `working-directory:`. Its corpus's
  independent verifier is an `independent:` line, `<name> <area> [needs=<packages>]
  [verdicts=<file>] [dir=<dir>] python3 [-I] <script> <args>`, the command line its README
  gives, run in `wai/` by the job's one step `wai conform --independent` and never by the body;
  `wai-rs/build.rs` reads the binary's table of independent verifiers from these lines. A file
  with such lines and no body is a declaration: its verifiers run in that step alone. Prose
  comments follow the header, after a `#` line.
- `corpora/<name>.txt`: one cargo-class corpus, verified by its own tool on every leg of
  `cargo-classes` (`corpus:`, `order:`, `bin:`, `dir:`), and written by it through
  `wai conformance gen --suite <corpus>`: its `gen` mode, or the modes `gen:` names in order
  (`none` where the tool writes nothing and the corpus's README says what does).
  `wai-rs/build.rs` reads these files for that command's table, and a `dir:` that names no
  corpus fails the build.
- A test file of `wai/wai-rs/tests/` whose first line is `// wai-conformance: int-kernels`
  runs in the fast integer kernels' steps of both profiles (`int-kernels-release`: the
  release step only; `int-kernels-amd`: the AVX-512 host too). The steps' features are the
  tagged tests' `required-features`.
- `baseline.json`: the lists the workflow kept by hand before they were derived. The
  repository checks require every derived list to hold every entry of it, and every step it
  names to run.

To see what the workflow runs: `python3 scripts/wai-conformance-lists.py dry-run` (of another
commit: `--ref <commit>`; two of them diff line by line). To run one step as CI does:
`python3 scripts/wai-conformance-lists.py run --only <name>`. To check the files:
`python3 scripts/wai-conformance-lists.py check`.