Generated artefacts

Generated artefacts

These files are generated from the schema in src/github_actions/schema/ and never edited by hand. CONTRIBUTING.md asks that the output be committed after each schema edit.¹ The pre-commit configuration excludes them, so that no hook rewrites what the next run would rewrite back.

project/

just gen-project runs LinkML’s gen-project with .linkml/generators.yaml, which skips the markdown generator and merges imports for the others.² The recipe then moves the Python output into src/github_actions/datamodel/ and writes the Pydantic model with gen-pydantic. It runs gen-java, gen-typescript and gen-owl on their own, because some generators ignore the configuration file or cannot create directories.³ project/ holds one folder for each of excel, graphql, java (one file per class), jsonld (the context and the schema), jsonschema, owl, prefixmap, protobuf, shacl, shex, sqlschema and typescript.

The Python models

src/github_actions/datamodel/github_actions.py holds the dataclasses, and github_actions_pydantic.py holds the Pydantic models. Validate data against the schema says what each checks.

docs/schema/ and docs/elements/

just gen-doc writes docs/schema/github_actions.yaml with gen-yaml, and the schema’s Markdown pages into docs/elements/. project.justfile says that the first file copies in the modules’ elements but keeps the imports: list. So a tool that loads it looks for the modules beside it.⁴ just gen-merged, run after gen-doc, writes docs/schema/github_actions_merged.yaml, which has no imports, for vendoring or loading offline. Git ignores the pages in docs/elements/, and the documentation site builds them when it needs them.

The domain schema copy

just lokf-adapt writes .lokf/github-actions.yaml, the bundle’s domain schema, and just lokf-adapt-check fails when it is stale. github-actions LinkML schema says what the copy changes.

Footnotes

1. CONTRIBUTING.md, the table of paths and the first item of Before opening a pull request ↩

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

3. justfile, the gen-project recipe ↩

4. project.justfile, the comment above gen-merged ↩