You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,9 @@ This repo is intentionally narrower than:
21
21
- a packaged `release-checklist` CLI for validating YAML-based release gate configurations
22
22
- starter templates generated with `release-checklist init`
23
23
- example configurations for medium-risk and high-risk AI systems
24
-
- typed validation for known metadata fields, boolean gates, and bounded numeric values
24
+
- typed validation for known metadata fields, boolean gates, bounded numeric values, and expected mapping shapes
25
25
- text, JSON, and Markdown reporting for local use and CI pipelines
26
+
- GitHub Actions CI covering supported Python versions and packaged CLI behavior
26
27
27
28
## How it works
28
29
@@ -44,6 +45,8 @@ The validator expects a nested YAML structure with these top-level sections:
44
45
-`infrastructure`
45
46
- optional but supported: `incident_readiness`
46
47
48
+
Known nested sections such as `model_validation.performance`, `governance.approvals`, and `infrastructure.testing` are expected to be mappings rather than free-form lists or strings.
49
+
47
50
## Quick start
48
51
49
52
```bash
@@ -118,8 +121,10 @@ The validator currently enforces:
118
121
- required metadata fields
119
122
- allow-listed values for environment, industry, and risk tier
120
123
- semver-like version formatting such as `1.0.0`
124
+
- mapping/object shape checks for known structural sections
121
125
- boolean typing for known gates
122
126
- bounded numeric validation for known fields such as `accuracy_threshold`
127
+
- positive numeric validation for known monitoring fields such as `latency_ms`
123
128
124
129
This repository is meant to be useful in real workflows, but it is still a lightweight validator rather than a full policy engine.
0 commit comments