adr-integration

Integrate ADRs into CI/CD pipelines and documentation workflows.

5|3|Updated Jan 17, 2026
One-click install
npx skills add https://github.com/zircote/adr --skill adr-integration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-integration
Source: https://github.com/zircote/adr/tree/main/skills/adr-integration
Command: npx skills add https://github.com/zircote/adr --skill adr-integration

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

ADRs often drift from code and docs as projects evolve; this skill provides guidance to align ADRs with CI/CD pipelines, documentation sites, and tooling so decisions stay visible and enforceable.

Core Features & Use Cases

  • CI/CD integration guidance for popular pipelines (GitHub Actions, GitLab CI) and hooks to automatically validate and index ADRs.
  • Documentation site integration recommendations for MkDocs, Docusaurus, and Sphinx to publish ADRs alongside code.
  • Automation patterns and examples to export, index, and cross-link ADRs across repositories and tooling.
  • Real-world use cases including continuous ADR validation, indexing, and site publishing to ensure decision traceability.

Quick Start

Ask the AI to outline an ADR CI/CD integration plan for your project.

Frequently Asked Questions about adr-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate ADR validation into a CI/CD pipeline?

ADR validation integrates into CI/CD pipelines through pre-commit hooks and workflow configurations. Tools like GitHub Actions and GitLab CI automate the indexing and cross-linking of ADRs to ensure decisions stay synchronized with code changes.

Can I publish ADRs to documentation sites like MkDocs or Docusaurus?

Yes, ADRs can be published directly to documentation sites. Integration guidance is provided for MkDocs, Docusaurus, and Sphinx to export and surface architectural decisions alongside existing project documentation.

What is the best way to keep architectural decision records synchronized with code?

Keeping ADRs synchronized with code requires automating validation within CI/CD workflows. By applying pre-commit hooks and continuous indexing patterns, teams prevent ADR drift and maintain decision traceability across repositories.

Does this ADR tooling work with both GitHub Actions and GitLab CI?

Yes, the ADR tooling works with both GitHub Actions and GitLab CI. It provides concrete configuration examples for both platforms to automate workflow validation, indexing, and site publishing.

How do pre-commit hooks enforce ADR documentation standards?

Pre-commit hooks enforce ADR documentation standards by validating decisions locally before code is pushed. This automation pattern prevents drift by ensuring ADRs are properly indexed and formatted before entering the remote pipeline.

When do I need to automate ADR indexing across repositories?

Automating ADR indexing across repositories is needed when projects scale and decisions risk drifting from code. Automation patterns export, index, and cross-link ADRs to maintain visibility and enforce traceability across multiple tooling environments.