Skip to content

Add ADR auto-generation and tracking for deployments#45

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-adr-auto-generation-tracking
Draft

Add ADR auto-generation and tracking for deployments#45
Copilot wants to merge 2 commits intomainfrom
copilot/add-adr-auto-generation-tracking

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 5, 2026

Git-ape generates architecture diagrams but doesn't produce or track Architecture Decision Records. This adds automatic ADR generation after each deployment, maintaining a governed ledger of infrastructure decisions.

Core script: .github/scripts/adr-manager.sh

  • generate <deployment-id> — reads metadata/requirements/WAF review, creates numbered ADR in .azure/adrs/, links back via metadata.json
  • amend <deployment-id> [reason] — appends amendment entries; marks ADR as "Superseded" on destroy
  • index — rebuilds INDEX.md table
  • list — displays all ADRs with status

Workflow integration

  • deploy workflow — "Generate ADR" step runs after successful deployment, commits ADR alongside state.json
  • destroy workflow — "Amend ADR" step appends destruction record to linked ADR

ADR format

# ADR-0001: Deploy api dev infrastructure in eastus

## Status
Accepted

## Deployment
- Deployment ID, project, environment, region, resource group

## Context / Decision / Consequences / Trade-offs / Architecture / Amendments

Metadata linkage

After generation, metadata.json gains:

{ "adrFile": ".azure/adrs/0001-deploy-api-dev.md", "adrNumber": 1 }

Other changes

  • deployment-manager.sh show displays linked ADR
  • website/docs/deployment/adrs.md documents lifecycle
  • .github/skills/adr-generator/SKILL.md skill definition for agent invocation
  • State docs updated with .azure/adrs/ directory structure

- Add adr-manager.sh script with generate, amend, index, and list commands
- Add adr-generator skill definition
- Update deploy workflow to generate ADR after successful deployment
- Update destroy workflow to amend ADR when deployment is destroyed
- Update deployment-manager.sh to show linked ADR in deployment details
- Update state.md to document ADR directory structure and metadata fields
- Add ADR documentation page (website/docs/deployment/adrs.md)
- Regenerate docs to include new skill

Agent-Logs-Url: https://github.com/Azure/git-ape/sessions/38650766-10c9-4746-b681-0a53bc22efe1

Co-authored-by: arnaudlh <20535201+arnaudlh@users.noreply.github.com>
Copilot AI changed the title [WIP] Add ADR auto-generation and tracking functionality Add ADR auto-generation and tracking for deployments May 5, 2026
Copilot AI requested a review from arnaudlh May 5, 2026 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Architecture Decision Records (ADR) auto-generation and tracking

2 participants