Generated artefacts

Generated artefacts

Every file here is generated from src/cis_controls/schema/cis_controls.yaml, so a change starts in the schema and the recipes rewrite the rest.

just gen-project runs gen-project with .linkml/generators.yaml into project/, moves the Python dataclasses into src/cis_controls/datamodel/, and writes the Pydantic models beside them. It then runs gen-java, gen-typescript and gen-owl separately, because some generators ignore the configuration or cannot create their folders, as its comment says.¹ .linkml/generators.yaml leaves out the Markdown generator and merges imports for the others.² project/ holds a folder each for Excel, GraphQL, Java, JSON-LD, JSON Schema, OWL, the prefix map, protobuf, SHACL, ShEx, SQL and TypeScript.³ The Java folder holds one class per schema class, three in all.

just gen-doc writes docs/schema/cis_controls.yaml and the element pages under docs/elements/, which git ignores and the website builds. just lokf-adapt writes .lokf/cis-controls.yaml. just test regenerates the dataclasses too, and leaves no change, because the generated files carry no generation date.

The pre-commit hooks leave these folders alone, and also the neighbours’ copies, the release tools’ lockfile and the sidecar’s scripts, because no hook may rewrite a file the repository does not write by hand.⁴

Footnotes

1. justfile, the gen-project and gen-doc recipes ↩

2. .linkml/generators.yaml, excludes and generator_args ↩

3. project, its folders ↩

4. .pre-commit-config.yaml, the exclude pattern and its comment ↩