CI
05917b9808
---ci---
phase: 2
milestone: v0.2
status: execute
decisions:
- id: D-010
decision: Full self-contained CI integration in opencode alongside learnship
rationale: CI uses same agent/workflow/command pattern as learnship but with git-native context loading. Commands prefixed ci- vs learnship-. Zero learnship dependencies.
confidence: 0.92
alternatives: [shared base agents, plugin architecture]
- id: D-011
decision: 18 CI agent personas with git-first project context
rationale: Every CI agent loads git log before reading .ci/ files. This ensures the git log IS the project memory — the core v0.2.0 design principle.
confidence: 0.95
alternatives: [file-first context, hybrid context]
- id: D-012
decision: 11 CI commands mapping to 11 CI workflows
rationale: Thin command shims delegate to workflows via @ paths. Matches learnship pattern for consistency. Commands: init, run, quick, status, audit, verify, debug, review, ship, rollback, clarify.
confidence: 0.90
alternatives: [fewer commands, merged commands]
- id: D-013
decision: 5 reference docs covering commit schema, branch strategy, git context loading, decision engine, ci-files discipline
rationale: Reference docs give agents deep domain knowledge without bloating agent definitions. Matches learnship reference pattern.
confidence: 0.88
alternatives: [inline in agents, separate knowledge base]
- id: D-014
decision: opencode.json adds ~/.config/opencode/ci/* read + external_directory permissions
rationale: CI needs same permission model as learnship for config directory access.
confidence: 0.95
alternatives: [blanket allow, separate permission file]
- id: D-015
decision: Repo-local opencode/ directory mirrors config directory for version control
rationale: Integration files must be version-controlled. The opencode/ directory in the repo can be installed to ~/.config/opencode/ during setup.
confidence: 0.85
alternatives: [separate repo, git submodule]
---/ci---
18 agents: orchestrator, planner, executor, verifier, researcher, challenger, security-auditor, debugger, code-reviewer, phase-researcher, plan-checker, project-researcher, research-synthesizer, roadmapper, ideation-agent, solution-writer, doc-writer, doc-verifier
11 workflows: init, run, quick, status, audit, verify, debug, review, ship, rollback, clarify
11 commands: ci-init, ci-run, ci-quick, ci-status, ci-audit, ci-verify, ci-debug, ci-review, ci-ship, ci-rollback, ci-clarify
5 references: commit-schema, branch-strategy, git-context-loading, decision-engine, ci-files-discipline
3 contexts: dev, research, review
69 lines
1.9 KiB
Markdown
69 lines
1.9 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>
|
|
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> |