OpenWriterControle/docs/getting-started/collision-handling.md
Darren Hinde c8f7103cb6
refactor(evals): consolidate documentation and enhance test infrastructure (#56)
* feat(agents): implement category-based agent organization system

- Organize agents into domain categories (core, development, content, data, product, learning)
- Move 10 agents to category subdirectories with proper git rename tracking
- Update 13 subagents with category and type metadata in frontmatter
- Add category metadata files (0-category.json) documenting common patterns
- Implement local registry fallback in install script for offline development
- Add comprehensive validation suite with 15 automated tests (100% pass rate)
- Enhance registry validation with duplicate ID and consistency checks
- Update eval framework with intelligent path resolution (backward compatible)
- Archive legacy eval structure to _archive/ for reference
- Update all documentation to reflect category-based structure
- Bump version to 0.5.0 with accurate CHANGELOG

Technical Details:
- 23 agents organized (10 category agents, 13 subagents)
- 6 category directories created
- Path resolution supports both agent IDs and category paths
- Registry schema updated to v2.0.0
- 159 files changed, 872 insertions(+), 10738 deletions(-)

BREAKING CHANGE: Agent file paths now use category structure. Update references from .opencode/agent/openagent.md to .opencode/agent/core/openagent.md. Eval framework maintains backward compatibility via path resolution.

* refactor(evals): consolidate documentation and enhance test infrastructure

- Remove temporary project tracking files (PHASE_5_COMPLETE, PROJECT_COMPLETE, etc.)
- Consolidate evaluation framework docs into main README
- Enhance test execution with improved logging and multi-prompt support
- Move system-builder from core to meta category
- Add comprehensive test suites for openagent with organized structure
- Create evaluation test structure for all subagents
- Clean up archived workflows and redundant documentation
- Update registry to reflect new agent organization
- Add shared test templates and golden test patterns

* feat(ci): add manual trigger support for bot-created PRs in validate-registry workflow

- Add pr_number input to workflow_dispatch for manually triggering validation
- Fetch PR details dynamically when triggered manually
- Support both automatic (PR event) and manual (workflow_dispatch) triggers
- Enable validation of bot-created PRs like automated version bumps
- Update branch detection and push logic to handle both trigger types
- Add documentation explaining how to manually trigger for bot PRs

* feat(evals): add explicit context file validation to test framework

- Add expectedContextFiles field to test YAML schema for explicit context file specification
- Enhance context-loading-evaluator to support both auto-detect and explicit validation modes
- Update documentation with comprehensive guide and examples
- Clean up archived legacy test structure (90+ old test files)
- Add new example tests demonstrating explicit context validation
- Backward compatible with existing tests

* feat(evals): add multi-agent logging system and performance optimizations

Implement comprehensive multi-agent logging and performance improvements for the eval framework.

Task 01: Multi-Agent Logging System
- Add complete hierarchical logging module (evals/framework/src/logging/)
  - SessionTracker: tracks parent-child delegation hierarchies
  - MultiAgentLogger: pretty-prints logs with visual indentation
  - Formatters: box characters and emoji formatting
  - 37 passing unit tests (session-tracker, logger, integration)
- Integrate with SDK event stream handler
  - Hook into session.created, message.updated, message.part.updated events
  - Real-time child session detection via timestamp heuristics
  - Message deduplication for cleaner output
- Enable in debug mode only (<1% performance overhead)
- Add demo script and comprehensive documentation

Task 02: Performance Optimizations
- Reduce grace period from 5s to 2s (67% reduction, 10-20% faster tests)
- Add PerformanceMetricsEvaluator for bottleneck identification
  - Collects tool latencies, inference time, idle time
  - Provides full performance visibility
- Update smoke test to validate delegation (core feature)
  - Replace simple read test with multi-agent delegation test
  - Tests both parent and child agent functionality
  - Validates multi-agent logging system

Results:
- 37 unit tests passing
- Smoke test passing (95/100 score)
- Clean hierarchical logging output
- 10-20% faster test execution
- Full multi-agent visibility

Files changed: 16 files, +2678 lines
Time saved: ~6-8 days (completed in 6 hours vs 3-5 day estimate)

* feat(evals): show child agent execution in non-debug mode

- Enable MultiAgentLogger in both debug and non-debug modes
- Add verbose parameter to control output level
- Non-verbose mode shows concise child session lifecycle:
  - Child agent started message
  - Child agent completed with duration
- Verbose mode (--debug) shows full delegation hierarchy
- Update documentation to reflect new behavior

This provides visibility into delegation without overwhelming output,
giving confidence that child agents are actually running.

* feat(evals): improve delegation testing and behavior validation

Major improvements to eval framework:

Test Suite:
- Add 00-smoke-test.yaml (basic read operation)
- Rename 01-smoke-test.yaml → 02-delegation-test.yaml (delegation test)
- Add simple-responder test agent for delegation testing
- Add debug test: simple-subagent-call.yaml

Evaluators:
- Add agent-model-evaluator.ts for agent/model validation
- Enhance behavior-evaluator.ts with detailed task tool output
- Improve delegation-evaluator.ts with better evidence tracking

Schema & Execution:
- Add expectedAgent and expectedModel to test schema
- Improve test executor with better logging and error handling

Documentation:
- Update evals/README.md with new features and performance improvements
- Remove outdated MULTI_AGENT_LOGGING_COMPLETE.md

Registry:
- Add simple-responder test agent to registry

Fixes:
- Fix dashboard.sh path resolution

These changes provide better visibility into delegation, improved test
coverage, and clearer validation of agent behavior.

* chore: add GitHub Actions workflow and plugin documentation

- Add .github/workflows/evals/run-evaluations.yml for automated eval testing
- Add dev/ai-tools/opencode/plugins/Plugin-inspiration.md for plugin development reference
2025-12-18 09:52:11 +00:00

221 lines
5.9 KiB
Markdown

# Install Script Collision Handling - Quick Reference
## 🎯 What Changed
The install script now **detects file collisions** before installing and gives you **4 clear options**.
---
## 📊 The Flow
```
┌─────────────────────────────────────┐
│ Select Components to Install │
└──────────────┬──────────────────────┘
│
▼
┌─────────────────────────────────────┐
│ Scan for Existing Files │
│ (Check what would be overwritten) │
└──────────────┬──────────────────────┘
│
▼
┌──────┴──────┐
│ Collisions? │
└──────┬──────┘
│
┌───────┴────────┐
│ │
NO YES
│ │
▼ ▼
Install ┌──────────────────┐
Everything │ Show Report │
│ Ask User Choice │
└────────┬─────────┘
│
┌───────────────┼───────────────┬──────────────┐
│ │ │ │
▼ ▼ ▼ ▼
┌────────┐ ┌──────────┐ ┌──────────┐ ┌────────┐
│ Skip │ │Overwrite │ │ Backup & │ │ Cancel │
│Existing│ │ All │ │Overwrite │ │ │
└───┬────┘ └────┬─────┘ └────┬─────┘ └───┬────┘
│ │ │ │
▼ ▼ ▼ ▼
Install Install All Backup Files Exit
New Only (Replace) Then Install
```
---
## 🎨 The 4 Options Explained
### Option 1: Skip Existing ✅ (SAFEST)
```
What happens:
✓ New files → Installed
✓ Existing files → Untouched
✓ Your changes → Preserved
Use when:
• You've customized files
• You only want new components
• You're doing incremental updates
Example:
10 selected, 5 exist
→ 5 installed, 5 skipped
```
### Option 2: Overwrite All ⚠️ (DESTRUCTIVE)
```
What happens:
✓ New files → Installed
✓ Existing files → REPLACED
✗ Your changes → LOST
Use when:
• You want latest versions
• You haven't customized anything
• You want to reset to defaults
Requires: Type 'yes' to confirm
Example:
10 selected, 5 exist
→ 10 installed (5 new, 5 replaced)
```
### Option 3: Backup & Overwrite 🔄 (RECOMMENDED)
```
What happens:
✓ Existing files → Backed up
✓ New files → Installed
✓ Existing files → Replaced
✓ Backup → Available for restore
Use when:
• You want new versions
• You want safety net
• You're not sure about changes
Backup location:
.opencode.backup.YYYYMMDD-HHMMSS/
Example:
10 selected, 5 exist
→ 5 backed up
→ 10 installed (5 new, 5 replaced)
```
### Option 4: Cancel ❌
```
What happens:
• Nothing changes
• Exit cleanly
Use when:
• You need to review first
• You want manual backup
• You're not ready
```
---
## 📋 Collision Report Example
```
⚠ Found 8 file collision(s):
Agents (2):
.opencode/agent/core/task-manager.md
.opencode/agent/core/opencoder.md
Subagents (3):
.opencode/agent/subagents/reviewer.md
.opencode/agent/subagents/tester.md
.opencode/agent/subagents/coder-agent.md
Commands (2):
.opencode/command/test.md
.opencode/command/commit.md
Context (1):
.opencode/context/core/essential-patterns.md
```
**Clear, organized, easy to review!**
---
## 🚀 Quick Decision Guide
| Your Situation | Best Option | Why |
|----------------|-------------|-----|
| First install | Any (no collisions) | Nothing exists yet |
| Adding new components | **Option 1: Skip** | Keeps your customizations |
| Want latest versions | **Option 3: Backup** | Safe update with rollback |
| Reset to defaults | **Option 2: Overwrite** | Clean slate (careful!) |
| Not sure | **Option 4: Cancel** | Review and decide later |
---
## 💡 Pro Tips
### Restore from Backup
```bash
# List backups
ls -la .opencode.backup.*/
# Restore one file
cp .opencode.backup.20251118-143022/.opencode/agent/my-agent.md .opencode/agent/
# Restore everything
rm -rf .opencode
mv .opencode.backup.20251118-143022/.opencode .opencode
```
### Update One File Only
```bash
# Delete the file you want to update
rm .opencode/agent/task-manager.md
# Run installer with "Skip existing"
# Only the deleted file gets reinstalled
```
### See What Changed
```bash
# Compare with backup
diff .opencode/agent/my-agent.md .opencode.backup.*/agent/my-agent.md
# Or use git
git diff .opencode/
```
---
## ✅ Benefits
| Before | After |
|--------|-------|
| ❌ Always overwrites | ✅ Asks first |
| ❌ All-or-nothing | ✅ Flexible strategies |
| ❌ No visibility | ✅ Clear collision report |
| ❌ No backup option | ✅ Optional backup |
| ❌ Risky updates | ✅ Safe incremental updates |
---
## 🎯 Summary
**The install script is now smart:**
1. **Detects** what would be overwritten
2. **Reports** collisions clearly
3. **Asks** how you want to proceed
4. **Respects** your choice
5. **Protects** your work
**You're in control!** 🎉