Packaging, rtut check, tests CI job; schemas move into the package (RBT-WP-0009-T02)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Assistant: claude-code Assistant-Model: sonnet Assistant-Process: 295952@bnt-lap001 Assistant-Session: e93f64ad-516c-46eb-9666-aad8d300c477
This commit is contained in:
parent
6d3414d8b7
commit
e021fd979f
16 changed files with 163 additions and 10 deletions
14
README.md
14
README.md
|
|
@ -4,11 +4,23 @@ A user interface specialized to present runbook tutorials that with parameters
|
|||
can guide through actual IT administration and operation tasks.
|
||||
|
||||
- **Intent:** `INTENT.md` · **Scope:** `SCOPE.md`
|
||||
- **Pack specification:** `docs/pack-spec.md` (v0.1, runnable) and `docs/pack-spec-v0.2.md` (v0.2: stages, gates, datapoints, actors, modes; validates, not yet runnable). Schemas in `schema/`. UX findings: `docs/ux-review-2026-09-29.md`
|
||||
- **Pack specification:** `docs/pack-spec.md` (v0.1, runnable) and `docs/pack-spec-v0.2.md` (v0.2: stages, gates, datapoints, actors, modes; validates, not yet runnable). Schemas in `rtut/schema/`. UX findings: `docs/ux-review-2026-09-29.md`
|
||||
- **Packs live where the procedure lives:** `runbooks/<pack>/pack.yaml` in the owning repo.
|
||||
Examples: `net-kingdom/runbooks/`, and here `runbooks/example-hello/` and
|
||||
`runbooks/showcase-lighthouse/` (a harmless story to try the UI on).
|
||||
|
||||
## Install
|
||||
|
||||
Python 3.12 or newer.
|
||||
|
||||
```bash
|
||||
make install # editable install with the test dependencies (pip install -e ".[test]")
|
||||
make check # validate every pack, attribute set, project and template
|
||||
make test # run the tests
|
||||
```
|
||||
|
||||
A plain `pip install .` works too and provides the `rtut` command; the JSON schemas ship inside the package.
|
||||
|
||||
```bash
|
||||
python3 -m rtut validate <repo-root> # validate every pack
|
||||
python3 -m rtut list <repo-root> # id, engine, maturity, title
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue