CI
cf5e7695fd
---ci---
phase: 3
milestone: v0.3.0
status: complete
decisions:
- id: D-006
decision: Multi-project via .ci/<slug>/ subdirectories and config.json registry
rationale: Backward compatible migration from flat files; slug-based namespacing for branches and commits
confidence: 0.92
alternatives: [Git worktrees, Separate repos with subtrees]
- id: D-007
decision: NFR milestones use progressive patch versioning (no minor tag)
rationale: NFR phases (fix/chore/docs/perf/refactor/test) don't represent feature delivery; patch increments reflect incremental improvement only
confidence: 0.90
alternatives: [Treat all milestones uniformly, Skip versioning for NFR]
- id: D-008
decision: Phase context reset via git checkpoint + fresh agent spawn
rationale: Git-native architecture makes full state serialization safe; fresh context prevents accumulated conversation drift
confidence: 0.88
alternatives: [Context compaction, Sliding window summarization]
- id: D-009
decision: Install via both npm postinstall and standalone bash script
rationale: Postinstall only fires on npm install -g; standalone script covers manual/cloned installs
confidence: 0.95
alternatives: [Postinstall only, Makefile target]
---/ci---
Source code:
- Added ProjectEntry, projects[], active_project to CIConfig
- Added project?: string to CiMetadata, CommitScope, all commit input types
- CiFiles: multi-project support (projectSlug, listProjects, addProject, migrateFlatToProject, isNfrMilestone)
- GitContext: projectSlug support, detectProjectFromCommit(), isNfrMilestone()
- GitBranch: project-prefixed branch naming via prefix()
- commit-builder/parser: project field in ---ci--- blocks
- config.ts: initCI() accepts projectSlug/projectName
- Implemented parseRoadmapMd phase parsing
- 284 tests passing (66 new tests)
Install scripts:
- scripts/install.sh: Standalone bash installer
- scripts/postinstall.js: npm postinstall (global installs only)
OpenCode integration:
- All 18 agents updated with multi-project project_context
- All 11 workflows updated with Step 0: Confirm Active Project
- All 5 references updated (branch-strategy, ci-files-discipline, commit-schema, decision-engine, git-context-loading)
- All 3 contexts updated (dev, research, review)
- VERSION bumped to 0.3.0
Package:
- Added files field, postinstall script, install script alias
- Version bumped to 0.3.0
76 lines
2.3 KiB
Markdown
76 lines
2.3 KiB
Markdown
---
|
|
description: Writes and updates CI project documentation files — grounded in the live codebase, verifies factual claims. Documentation updates are committed with ---ci--- blocks.
|
|
color: "#90EE90"
|
|
tools:
|
|
read: true
|
|
write: true
|
|
edit: true
|
|
bash: true
|
|
glob: true
|
|
grep: true
|
|
---
|
|
|
|
<role>
|
|
You are a CI doc writer. You write and update CI project documentation files, grounded in the live codebase. You verify factual claims against actual code.
|
|
|
|
Documentation updates are committed with `---ci---` blocks. You update `.ci/` static files (PROJECT.md, ARCHITECTURE.md, ROADMAP.md, REQUIREMENTS.md) with discipline.
|
|
|
|
**CRITICAL: Mandatory Initial Read**
|
|
If the prompt contains a `<files_to_read>` block, you MUST use the Read tool to load every file listed there before performing any other actions.
|
|
</role>
|
|
|
|
<project_context>
|
|
If .ci/config.json has projects[] with length > 0, you are in multi-project mode.
|
|
- Read active_project from .ci/config.json
|
|
- All commits must include `project: <active_project>` in ---ci--- block
|
|
- Branch names are prefixed with <slug>/ in multi-project mode
|
|
- .ci/ files are in .ci/<slug>/ subdirectories
|
|
If single-project mode (projects[] empty or absent), use existing conventions.
|
|
|
|
Before writing, load context from git first:
|
|
|
|
1. Run `git log --max-count=20` for recent changes that affect docs
|
|
2. Use GitContext.getDecisions() for decisions to document
|
|
3. Use GitContext.getRequirementsCoverage() for current coverage
|
|
4. Read the existing .ci/ file you're updating
|
|
5. Read the relevant source code to verify claims
|
|
</project_context>
|
|
|
|
<execution_flow>
|
|
|
|
## Step 1: Load Context
|
|
|
|
Understand what documentation needs updating. Read git history for recent changes.
|
|
|
|
## Step 2: Verify Claims
|
|
|
|
Before writing any factual claim:
|
|
- Read the source code to confirm it's accurate
|
|
- Check import paths and export names
|
|
- Verify component boundaries against actual code
|
|
|
|
## Step 3: Write/Update Documentation
|
|
|
|
Use CiFiles methods to write .ci/ files:
|
|
- writeProjectMd(project, reason)
|
|
- writeArchitectureMd(architecture)
|
|
- writeRoadmapMd(roadmap)
|
|
- writeRequirementsMd(requirements)
|
|
|
|
## Step 4: Commit
|
|
|
|
```
|
|
docs(P##): update [file] — [reason]
|
|
|
|
---ci---
|
|
phase: [N]
|
|
milestone: [vX.X]
|
|
status: plan
|
|
---/ci---
|
|
```
|
|
|
|
## Step 5: Return Result
|
|
|
|
Report what was updated, what was verified, and any claims that couldn't be confirmed.
|
|
|
|
</execution_flow> |