Skip to content

Tooling and Continuous Integration

Purpose

Defines the minimum tooling and CI pipeline required to maintain UC-BoK as a model-driven, validated knowledge base.

Required Tooling

Tool Version Purpose
Python 3.12+ Scripts, validators, generators
PyYAML Latest YAML catalog parsing
jsonschema Latest JSON Schema validation
MkDocs Latest Documentation site
MkDocs Material Latest Theme and extensions

Install all dependencies:

pip install -r requirements.txt

Local Commands

Command What it does
make check Full pipeline: structure + validate + indexes + graph
make validate YAML reference integrity check
make validate-ontology 39 Business Objects against schema
make validate-capabilities 22 Capabilities against schema
make validate-events 73 Events against schema
make validate-processes 12 Processes against schema
make validate-applications 12 Applications against schema
make generate Regenerate all catalog pages from YAML
make indexes Regenerate model indexes
make graphs Regenerate Mermaid graphs
make structure Check repository layout
make site Build MkDocs site in strict mode

Run before every commit:

make check

Continuous Integration

Workflow Trigger Purpose
validate-model.yml Push, PR Full make check pipeline
build-docs.yml Push to main MkDocs strict build

Governance

  • Pull requests SHALL pass all make check validators before merge.
  • Generated files under docs/generated/ SHALL be committed when YAML catalogs change.
  • Model validation failures SHALL block publication.
  • Pages under docs/generated/ SHALL NOT be edited manually.