Appearance
SOP-009: Artifact Publish & Index
Version: 1.0 · Owner: Platform / SRE · Gate: G1 (publish)
Purpose & scope
Publish Accepted ADRs and Approved specs from Git to human discovery surfaces and AI agent indexes.
Roles
| Role | RACI |
|---|---|
| Platform / SRE | R/A — pipeline health |
| ARCH | C — content validation |
| AIPO | C — index/RAG config |
Prerequisites
- Merge to
mainof files underdocs/adr/orspecs/ - CI publish workflow enabled
Procedure
- Validate on merge — CI checks: ADR front matter valid, status allowed, links resolve, spec
x-status: approvedfor indexing. - Build static site — MkDocs/Docusaurus → S3 bucket
artifacts.{org}.com. - Invalidate CDN — CloudFront invalidation for
/adr/*and/specs/*. - Sync Backstage — TechDocs plugin pulls from Git or S3; catalog entity links updated.
- Re-index — OpenSearch Ingestion (or Kendra) ingests Accepted ADRs + Approved specs only.
- MCP refresh — ADR/spec MCP server cache invalidated or webhook triggered.
- Verify — Smoke test: MCP
search_adrreturns new doc within 15 min.
Definition of Done
- [ ] Static site updated
- [ ] Backstage shows new revision
- [ ] Search index contains document (if status qualifies)
- [ ] MCP returns document in smoke test
SLA
- End-to-end publish: ≤ 15 minutes from merge
Failure handling
| Failure | Action |
|---|---|
| Index lag | Page platform on-call; devs use Git path as fallback |
| Broken links in ADR | CI should block merge; if prod index stale, hotfix PR |