v1.1.0 - GitHub Action Validator

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/decisions

Highlights

• 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

Full Changelog

v1.0.0...v1.1.0

Structured MADR v1.0.0

Structured MADR v1.0.0

Machine-Readable Architectural Decision Records for the AI Era

Highlights

• YAML Frontmatter: Machine-parseable metadata for tooling integration
• Hierarchical Decision Drivers: Primary and secondary drivers for clear prioritization
• Risk Assessment: Technical, schedule, and ecosystem risk ratings per option
• Split Consequences: Positive, negative, and neutral outcomes
• Audit Section: Built-in compliance tracking with findings tables

What's Included

• SPECIFICATION.md - Formal RFC-style specification
• schemas/structured-madr.schema.json - JSON Schema for validation
• templates/template.md - Full template with guidance
• templates/template-bare.md - Minimal template for experienced users
• examples/ - Real-world example ADRs

Documentation

• Specification
• Contributing Guide

License

MIT License