stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 1 Releases Wiki Activity
Files
7600caea632e9e44571bc1661003948a5e1d22fb
git.stella-ops.org/docs/devops/policy-schema-export.md
root 68da90a11a
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Details
Restructure solution layout by module
2025-10-28 15:10:40 +02:00

1.2 KiB
Raw Blame History

Policy Schema Export Automation

This utility generates JSON Schema documents for the Policy Engine run contracts.

Command

scripts/export-policy-schemas.sh [output-directory]

When no output directory is supplied, schemas are written to docs/schemas/.

The exporter builds against StellaOps.Scheduler.Models and emits:

  • policy-run-request.schema.json
  • policy-run-status.schema.json
  • policy-diff-summary.schema.json
  • policy-explain-trace.schema.json

The build pipeline (.gitea/workflows/build-test-deploy.yml, job Export policy run schemas) runs this script on every push and pull request. Exports land under artifacts/policy-schemas/<commit>/, are published as the policy-schema-exports artifact, and changes trigger a Slack post to #policy-engine via the POLICY_ENGINE_SCHEMA_WEBHOOK secret. A unified diff is stored alongside the exports for downstream consumers.

CI integration checklist

  • Invoke the script in the DevOps pipeline (see DEVOPS-POLICY-20-004).
  • Publish the generated schemas as pipeline artifacts.
  • Notify downstream consumers when schemas change (Slack #policy-engine, changelog snippet).
  • Gate CLI validation once schema artifacts are available.