Skip to content

Commit d54825b

Browse files
committed
Clarify validation guarantees and CI coverage in README
1 parent 46fdc4b commit d54825b

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ This repo is intentionally narrower than:
2121
- a packaged `release-checklist` CLI for validating YAML-based release gate configurations
2222
- starter templates generated with `release-checklist init`
2323
- 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
2525
- text, JSON, and Markdown reporting for local use and CI pipelines
26+
- GitHub Actions CI covering supported Python versions and packaged CLI behavior
2627

2728
## How it works
2829

@@ -44,6 +45,8 @@ The validator expects a nested YAML structure with these top-level sections:
4445
- `infrastructure`
4546
- optional but supported: `incident_readiness`
4647

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+
4750
## Quick start
4851

4952
```bash
@@ -118,8 +121,10 @@ The validator currently enforces:
118121
- required metadata fields
119122
- allow-listed values for environment, industry, and risk tier
120123
- semver-like version formatting such as `1.0.0`
124+
- mapping/object shape checks for known structural sections
121125
- boolean typing for known gates
122126
- bounded numeric validation for known fields such as `accuracy_threshold`
127+
- positive numeric validation for known monitoring fields such as `latency_ms`
123128

124129
This repository is meant to be useful in real workflows, but it is still a lightweight validator rather than a full policy engine.
125130

@@ -140,6 +145,7 @@ tests/
140145
test_validator.py
141146
requirements.txt
142147
pyproject.toml
148+
.github/workflows/ci.yml
143149
```
144150

145151
## Related repositories

0 commit comments

Comments
 (0)