Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ inputs:
required: false
default: "true"
version:
description: "modelith release to install, e.g. 'v0.4.0'. Bumped manually after each release — see CLAUDE.md's release checklist in the modelith repo."
description: "modelith release to install, e.g. 'v0.5.0'. Bumped manually after each release — see CLAUDE.md's release checklist in the modelith repo."
required: false
default: "v0.4.0"
default: "v0.5.0"

runs:
using: "composite"
Expand Down
16 changes: 8 additions & 8 deletions docs/08-github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: stacklok/modelith@v0.4.0
- uses: stacklok/modelith@v0.5.0
with:
files: "model.modelith.yaml"
version: v0.5.0
completeness: warn
check-rendered: true
```
Expand All @@ -33,7 +34,7 @@ jobs:
| `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` | `v0.4.0` | Published `modelith` release to install. Set another published release to select it. |
| `version` | action-ref-dependent | Published `modelith` release to install; defaults to the release configured by the referenced action version. Set another published release to select it. |

Multiple files / globs:

Expand All @@ -48,8 +49,9 @@ with:

The action downloads the prebuilt `modelith` release binary for the runner's OS
and architecture, verifies it against the release's published checksums, and runs
it. The `version` input defaults to `v0.4.0`; set it to another published release
when you need a different version. Pinning your `uses:` reference to a commit SHA
it. The example sets the `version` input explicitly to `v0.5.0`; set it to
another published release when you need a different version. Pinning your
`uses:` reference to a commit SHA keeps CI runs reproducible: a given action
keeps CI runs reproducible: a given action commit installs the selected
`modelith` version.

Expand All @@ -61,10 +63,8 @@ completeness findings for that copy and lets `check-rendered` skip a missing
`.md` or a model this version cannot render. Structural and semantic findings,
including a provenance-header defect or a changed copy, still fail the action.

The default `v0.4.0` binary does not include vendored-model support. Select a
published release that does before relying on this behavior. See [Vendoring a
model from another repository](./10-vendoring.md) for provenance and render
semantics.
The default `v0.5.0` release supports this behavior. See [Vendoring a model from
another repository](./10-vendoring.md) for provenance and render semantics.

## Regenerating the Markdown

Expand Down
2 changes: 1 addition & 1 deletion plugin/.claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "modelith",
"version": "0.4.0",
"version": "0.5.0",
"description": "Author, validate, and render domain models by conversation instead of hand-writing YAML. Three skills: draft/update the model, lint and explain findings, and load an existing model into a coding session so the agent reasons in your team's vocabulary. Requires the modelith CLI.",
"author": {
"name": "Stacklok"
Expand Down
Loading