GitHub Action

Any repo can lint its domain model and verify the committed Markdown in CI by referencing this repo as an action.

# .github/workflows/domain-model.yml
name: Domain Model
on: [pull_request]

jobs:
  domain-model:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: stacklok/modelith@v1
        with:
          files: "model.modelith.yaml"
          completeness: warn
          check-rendered: true

Inputs

Input	Default	Description
files	— (required)	YAML files or globs, space-, comma-, or newline-separated.
completeness	warn	Treat completeness gaps as warn or error.
check-rendered	true	Verify the committed *.md matches the YAML.
version	(pinned to a specific release)	modelith release to install, e.g. v0.4.0.

Multiple files / globs:

with:
  files: |
    docs/*.modelith.yaml
    services/**/model.modelith.yaml

How it works

The action downloads the prebuilt modelith release binary for the runner's OS/arch and verifies it against the release's published checksums before running it. The version input defaults to a specific release pinned in action.yml — combined with pinning your uses: reference to a commit SHA, this keeps CI runs reproducible: a given action commit always installs the same modelith version.

Regenerating the Markdown

The action gates; it does not commit. When check-rendered fails, run modelith render <file> locally, commit the updated .md, and push — so the rendered output is reviewed in the PR like any other change.