Skip to content

Playbooks

  • Derive and check concepts from workflow files checked by automation only, still a draft
    How to run scripts/derive.py, which derives concept frontmatter and check names from a repository’s workflow and action files and reports drift from a knowledge bundle, and scripts/github_export.py, which fetches the rulesets and check runs that derive.py also compares; here derive.py runs with –exclude tests/.

  • Knowledge sources map checked by automation only, still a draft
    The librarian’s scrape map: every repository location and external page this bundle derives concepts from, the concepts each yields, how to re-check each on a refresh run, and the paths left out on purpose.

  • Move the upstream pins checked by automation only, still a draft
    What to do when the upstream watch opens its issue: replace both SchemaStore files from one commit and move PINNED_COMMIT, the schema header’s source and annotations and NOTICE; or read a newer REST API version’s breaking changes and move PINNED_API_VERSION; tests/test_schema_rules.py checks that the header and the script agree on the pins and the reading date.

  • Regenerate and test the schema checked by automation only, still a draft
    How to change the github-actions schema: set up with uv and just, edit src/github_actions/schema/, regenerate with just gen-project, gen-doc, gen-merged and lokf-adapt, add examples, then run the checks CI runs (just test on Python 3.10 to 3.14, just lint and just lokf-adapt-check on 3.13) and the pre-commit hooks.

  • Release the schema checked by automation only, still a draft
    How a releasing commit merged to main makes semantic-release promote the changelog’s Unreleased section, tag vX.Y.Z and publish a GitHub Release, then dispatch the Knowledge Release workflow once KNOWLEDGE_RELEASE_ENABLED is true; below 1.0.0 from a v0.0.0 baseline tag, with a breaking change as a minor bump and nothing published to PyPI.

  • Validate data against the schema checked by automation only, still a draft
    How to check a YAML file against the github-actions schema with linkml-validate (for example with -C GhaReusableWorkflow), what the generated dataclass and Pydantic models check less, and the rules no tool checks, such as a repeated input_id or a read-all that does not stand alone.