docs(README): link policies/ and CI workflow; add local validation snippets
This commit is contained in:
parent
961102ca6f
commit
baa8b61021
1 changed files with 23 additions and 1 deletions
24
README.md
24
README.md
|
|
@ -60,12 +60,34 @@ schemas/
|
|||
expense/canonical/v1.0.0.json
|
||||
ds/expense/project_assignment/v1.0.0.json
|
||||
sink/db/expense/v1.0.0.json
|
||||
policies/
|
||||
README.md # Policy-Klassen, Input-Verträge, Deployment
|
||||
transformations/expense.rego (+ _test.rego)
|
||||
sinks/expense_db_app.rego (+ _test.rego)
|
||||
data_sources/expense_db_app.rego (+ _test.rego)
|
||||
.forgejo/workflows/
|
||||
validate.yml # JSON-Schema (ajv) + Rego (opa fmt + opa test)
|
||||
```
|
||||
|
||||
Weitere Verzeichnisse (Services, Policies, Deployment-Manifeste, Senken-/Datenquellen-Adapter) folgen im Zuge der Architekturentwicklung.
|
||||
Weitere Verzeichnisse (Services, Deployment-Manifeste, Senken-/Datenquellen-Adapter) folgen im Zuge der Architekturentwicklung.
|
||||
|
||||
## Einstiegspunkte
|
||||
|
||||
- [Architektur V1.1](docs/architecture/v1.1.md) — Zielbild
|
||||
- [ADRs](docs/adr/README.md) — getroffene Entscheidungen
|
||||
- [Schemas](schemas/README.md) — kanonische Business-, Datenquellen- und Senken-Formate
|
||||
- [Policies](policies/README.md) — OPA/Rego-Policies für Transformationen, Senken und Datenquellen
|
||||
|
||||
## Lokal validieren
|
||||
|
||||
```bash
|
||||
# JSON-Schemas
|
||||
npx -y ajv-cli@5 compile --spec=draft2020 -c ajv-formats \
|
||||
-s schemas/expense/canonical/v1.0.0.json
|
||||
|
||||
# Rego
|
||||
opa fmt --list --diff policies/
|
||||
opa test policies/ -v
|
||||
```
|
||||
|
||||
CI (`.forgejo/workflows/validate.yml`) läuft dieselben Prüfungen auf jedem Push und PR gegen `main`.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue