Azure / Azure/git-ape

Architecture Decision Records (ADR) auto-generation and tracking

Open
#28 1 comment 1 reaction 2 assignees Claimed by @arnaudlh View on GitHub
documentation enhancement
Dominant language
JavaScript
Stars
269
Forks
45
Avg merge
18h 41m
Merged PRs (30d)
11

Description

## Description

The manifesto positions ADRs, reference architectures, and security standards as the "governing ledger" in an agentic model. Git-ape currently generates architecture diagrams but does not produce or track Architecture Decision Records.

## Scope

1. **ADR generation** — After each deployment, auto-generate an ADR documenting: what was deployed, why (requirements), alternatives considered, trade-offs accepted (from WAF review), and the final architecture diagram.
2. **ADR directory** — `.azure/adrs/` with numbered ADR files following the standard format (Title, Status, Context, Decision, Consequences).
3. **ADR index** — Auto-maintained `INDEX.md` listing all ADRs with status.
4. **ADR references in deployments** — Each deployment's `metadata.json` links to its ADR.
5. **ADR evolution** — When a deployment is updated or destroyed, the ADR is amended with the change rationale.

## Acceptance Criteria

- [ ] Deployment pipeline generates an ADR after successful deployment.
- [ ] ADRs follow a consistent template (number, title, status, context, decision, consequences).
- [ ] ADR index is auto-maintained.
- [ ] Deployment metadata references the associated ADR.
- [ ] Updated deployments append to the existing ADR.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.