Files
16gagent/docs/README.md
T
2026-06-06 10:40:48 +08:00

135 lines
5.6 KiB
Markdown

# Active Memory Release Pipeline — Documentation Index
> Release Candidate 发布流水线完整文档入口
---
## Architecture
```
Payload
RC Checklist ← PR-13
Baseline ← PR-16
Release Gate ← PR-17
RC Report ← PR-15
CI Artifact ← PR-14
```
---
## Components
| Component | PR | Document | Source |
|-----------|----|----------|--------|
| RC Checklist | PR-13 | [Checklist Doc](./active-memory-release-candidate-checklist-report.md) | `src/active-memory/precompute-release-candidate-checklist.mjs` |
| CI Gate | PR-14 | [Pipeline Doc](./active-memory-release-candidate-pipeline.md) | `scripts/active-memory-release-candidate-check.mjs` |
| RC Report | PR-15 | [Report Doc](./active-memory-release-candidate-report.md) | `src/active-memory/generate-release-candidate-report.mjs` |
| Baseline Compare | PR-16 | [Baseline Doc](./active-memory-release-candidate-baseline-compare.md) | `src/active-memory/compare-release-candidate-baseline.mjs` |
| Release Gate | PR-17 | [Gate Doc](./active-memory-release-gate.md) | `src/active-memory/evaluate-release-gate.mjs` |
| Hardening & Tests | PR-18 | [Pipeline Overview](./active-memory-release-pipeline.md) | `test/active-memory/release-pipeline-*.test.mjs` |
| Production Validation | PR-20 | [Validation Report](./production-validation-report.md) | `test/fixtures/production-validation/` |
| Baseline Evolution | PR-21 | [Evolution Doc](./baseline-evolution.md) | `test/fixtures/baseline-evolution/` |
| Compatibility Matrix | PR-22 | [Matrix Doc](./compatibility-matrix.md) | `test/fixtures/compatibility-matrix/` |
---
## Documents
| Document | Description |
|----------|-------------|
| [Pipeline Overview](./active-memory-release-pipeline.md) | 完整 Release Pipeline 架构、流程、故障排查 |
| [RC Checklist (PR-13)](./active-memory-release-candidate-checklist-report.md) | 核心检查清单:5 项 blocker + warning 规则 |
| [CI Pipeline (PR-14)](./active-memory-release-candidate-pipeline.md) | CI 集成:workflow、exit code、管道模式 |
| [RC Report (PR-15)](./active-memory-release-candidate-report.md) | Markdown 报告生成:格式、CI 集成 |
| [Baseline Compare (PR-16)](./active-memory-release-candidate-baseline-compare.md) | 历史基线对比:阈值、指标、CLI |
| [Release Gate (PR-17)](./active-memory-release-gate.md) | 统一门禁决策:OPEN/CLOSED、审批 |
| [Maintenance Guide](./active-memory-maintenance.md) | 维护者指南:添加检查项、更新阈值、更新测试 |
| [Stable Baseline (PR-20)](./stable-baseline.md) | 第一版 Stable Baseline:来源、更新策略、生命周期 |
| [Production Validation (PR-20)](./production-validation-report.md) | 生产数据验证报告:阈值分析、发现、建议 |
| [Baseline Evolution (PR-21)](./baseline-evolution.md) | Baseline 生命周期、演化验证、阈值稳定性 |
---
## Quick Links
### Run Pipeline Locally
```bash
npm run active-memory:rc-check # RC Checklist
npm run active-memory:baseline-compare # Baseline Compare
npm run active-memory:release-gate # Release Gate
npm run active-memory:rc-report # Generate Report
npm run active-memory:rc-ci # Full CI pipeline (compose + check)
```
### Run Tests
```bash
# All release pipeline tests
node --test test/active-memory/release-pipeline-*.test.mjs \
test/active-memory/release-candidate-*.test.mjs \
test/active-memory/release-gate.test.mjs
# Contract tests only
node --test test/active-memory/release-pipeline-contract.test.mjs
# Compatibility Matrix tests
node --test test/active-memory/compatibility-matrix.test.mjs
# CLI Validation
node scripts/validate-compatibility-matrix.mjs
# CLI Validation (verbose)
node scripts/validate-compatibility-matrix.mjs --verbose
```
### Key Files
| Layer | Files |
|-------|-------|
| Source | `src/active-memory/precompute-release-candidate-checklist.mjs` |
| | `src/active-memory/compare-release-candidate-baseline.mjs` |
| | `src/active-memory/evaluate-release-gate.mjs` |
| | `src/active-memory/generate-release-candidate-report.mjs` |
| | `src/active-memory/baseline-thresholds.mjs` |
| Scripts | `scripts/active-memory-release-candidate-check.mjs` |
| | `scripts/active-memory-rc-ci-payload.mjs` |
| | `scripts/active-memory-release-candidate-baseline-compare.mjs` |
| | `scripts/active-memory-release-candidate-report.mjs` |
| | `scripts/active-memory-release-gate.mjs` |
| | `scripts/validate-compatibility-matrix.mjs` |
| Tests | `test/active-memory/release-pipeline-contract.test.mjs` |
| | `test/active-memory/release-pipeline-e2e.test.mjs` |
| | `test/active-memory/release-pipeline-regression.test.mjs` |
| | `test/active-memory/release-candidate-pipeline.test.mjs` |
| | `test/active-memory/release-candidate-baseline-compare.test.mjs` |
| | `test/active-memory/release-candidate-report.test.mjs` |
| | `test/active-memory/release-gate.test.mjs` |
| | `test/active-memory/compatibility-matrix.test.mjs` |
| Fixtures | `test/fixtures/release-pipeline/*.json` |
| | `test/fixtures/release-pipeline/report-*.md` |
| | `test/fixtures/compatibility-matrix/*.json` |
| CI | `.github/workflows/release-candidate.yml` |
---
## Status
| PR | Component | Tests | CI |
|----|-----------|-------|-----|
| PR-13 | RC Checklist | ✅ Pass | ✅ |
| PR-14 | CI Gate | ✅ Pass | ✅ |
| PR-15 | RC Report | ✅ Pass | ✅ |
| PR-16 | Baseline Compare | ✅ Pass | ✅ |
| PR-17 | Release Gate | ✅ Pass | ✅ |
| PR-18 | Hardening | ✅ Pass | ✅ |
| PR-19 | Docs & Cleanup | — | ✅ |
| PR-20 | Production Validation | ✅ Pass | ✅ |
| PR-21 | Baseline Evolution | ✅ Pass | ✅ |
| PR-22 | Compatibility Matrix | ✅ 33 tests Pass | ✅ |