GitHub Action Now Available on Marketplace
Validate your Structured MADR architectural decision records in CI/CD pipelines with a single workflow line.
Installation
- uses: zircote/structured-madr@v1
with:
path: docs/decisionsHighlights
- Shareable GitHub Action - Validate ADRs in any repository's CI/CD pipeline
- Comprehensive Validation - YAML frontmatter schema + body structure validation
- PR Annotations - See validation errors directly in pull request diffs
- Configurable - Adjust paths, patterns, strictness, and failure behavior
Features
| Feature | Description |
|---|---|
| Frontmatter Validation | JSON Schema validation using ajv |
| Section Ordering | Validates all 12 required sections in correct order |
| Option Analysis | Checks for Advantages/Disadvantages/Risk Assessment |
| Audit Section | Ensures compliance tracking entries exist |
| GitHub Annotations | Inline errors and warnings in PR reviews |
Action Inputs
| Input | Default | Description |
|---|---|---|
path |
docs/decisions |
Directory containing ADR files |
pattern |
**/*.md |
Glob pattern for ADR files |
schema |
(built-in) | Custom JSON Schema path |
strict |
false |
Fail on warnings |
fail-on-error |
true |
Fail workflow on errors |
Project ADRs (Dogfooding)
This release includes exemplar ADRs demonstrating the format:
- ADR-0001: Adopt Structured MADR Format for Project Documentation
- ADR-0002: Shareable GitHub Action for Structured MADR Validation