OpenWriterControle/Makefile
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

261 lines
9.9 KiB
Makefile

# OpenAgents - GitHub Project Management & Development
# Quick commands for managing your GitHub Project board and running tests
REPO := darrenhinde/OpenAgents
PROJECT_NUMBER := 2
OWNER := darrenhinde
.PHONY: help idea ideas board labels project-info issue-view issue-comment issue-close bug feature
.PHONY: test-evals test-golden test-smoke test-verbose build-evals validate-evals
help: ## Show this help message
@echo "OpenAgents GitHub Project Management"
@echo ""
@echo "Usage: make [target] [ARGS]"
@echo ""
@echo "Targets:"
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " %-20s %s\n", $$1, $$2}'
@echo ""
@echo "Examples:"
@echo " make idea TITLE=\"Add eval harness\" BODY=\"Description here\""
@echo " make bug TITLE=\"Fix login error\" BODY=\"Users can't login\""
@echo " make feature TITLE=\"Add dark mode\" PRIORITY=\"high\""
@echo " make ideas"
@echo " make board"
@echo " make issue-view NUM=123"
idea: ## Create a new idea (requires TITLE, optional BODY, PRIORITY, CATEGORY)
@if [ -z "$(TITLE)" ]; then \
echo "Error: TITLE is required"; \
echo "Usage: make idea TITLE=\"Your title\" BODY=\"Description\" PRIORITY=\"high\" CATEGORY=\"agents\""; \
exit 1; \
fi
@LABELS="idea"; \
BODY=$${BODY:-}; \
if [ -n "$(PRIORITY)" ]; then LABELS="$$LABELS,priority-$(PRIORITY)"; fi; \
if [ -n "$(CATEGORY)" ]; then LABELS="$$LABELS,$(CATEGORY)"; fi; \
gh issue create \
--repo $(REPO) \
--title "$(TITLE)" \
--body "$$BODY" \
--label "$$LABELS"
bug: ## Create a bug report (requires TITLE, optional BODY, PRIORITY)
@if [ -z "$(TITLE)" ]; then \
echo "Error: TITLE is required"; \
echo "Usage: make bug TITLE=\"Bug description\" BODY=\"Details\" PRIORITY=\"high\""; \
exit 1; \
fi
@LABELS="bug"; \
BODY=$${BODY:-}; \
if [ -n "$(PRIORITY)" ]; then LABELS="$$LABELS,priority-$(PRIORITY)"; fi; \
if [ -n "$(CATEGORY)" ]; then LABELS="$$LABELS,$(CATEGORY)"; fi; \
gh issue create \
--repo $(REPO) \
--title "$(TITLE)" \
--body "$$BODY" \
--label "$$LABELS"
feature: ## Create a feature request (requires TITLE, optional BODY, PRIORITY, CATEGORY)
@if [ -z "$(TITLE)" ]; then \
echo "Error: TITLE is required"; \
echo "Usage: make feature TITLE=\"Feature name\" BODY=\"Description\" PRIORITY=\"high\" CATEGORY=\"agents\""; \
exit 1; \
fi
@LABELS="feature"; \
BODY=$${BODY:-}; \
if [ -n "$(PRIORITY)" ]; then LABELS="$$LABELS,priority-$(PRIORITY)"; fi; \
if [ -n "$(CATEGORY)" ]; then LABELS="$$LABELS,$(CATEGORY)"; fi; \
gh issue create \
--repo $(REPO) \
--title "$(TITLE)" \
--body "$$BODY" \
--label "$$LABELS"
ideas: ## List all open ideas
@gh issue list --repo $(REPO) --label idea --state open
bugs: ## List all open bugs
@gh issue list --repo $(REPO) --label bug --state open
features: ## List all open features
@gh issue list --repo $(REPO) --label feature --state open
issues: ## List all open issues
@gh issue list --repo $(REPO) --state open
by-priority: ## List issues by priority (requires PRIORITY=high|medium|low)
@if [ -z "$(PRIORITY)" ]; then \
echo "Error: PRIORITY is required"; \
echo "Usage: make by-priority PRIORITY=high"; \
exit 1; \
fi
@gh issue list --repo $(REPO) --label "priority-$(PRIORITY)" --state open
by-category: ## List issues by category (requires CATEGORY=agents|evals|framework|docs)
@if [ -z "$(CATEGORY)" ]; then \
echo "Error: CATEGORY is required"; \
echo "Usage: make by-category CATEGORY=agents"; \
exit 1; \
fi
@gh issue list --repo $(REPO) --label "$(CATEGORY)" --state open
board: ## Open the project board in browser
@open "https://github.com/users/$(OWNER)/projects/$(PROJECT_NUMBER)"
labels: ## List all labels in the repo
@gh label list --repo $(REPO)
project-info: ## Show project information
@gh project view $(PROJECT_NUMBER) --owner $(OWNER)
project-items: ## List all items in the project
@gh project item-list $(PROJECT_NUMBER) --owner $(OWNER) --format json | jq -r '.items[] | "\(.id) - \(.content.title) [\(.content.state)]"'
issue-view: ## View an issue (requires NUM=issue_number)
@if [ -z "$(NUM)" ]; then \
echo "Error: NUM is required"; \
echo "Usage: make issue-view NUM=123"; \
exit 1; \
fi
@gh issue view $(NUM) --repo $(REPO)
issue-comment: ## Comment on an issue (requires NUM and COMMENT)
@if [ -z "$(NUM)" ] || [ -z "$(COMMENT)" ]; then \
echo "Error: NUM and COMMENT are required"; \
echo "Usage: make issue-comment NUM=123 COMMENT=\"Your comment\""; \
exit 1; \
fi
@gh issue comment $(NUM) --repo $(REPO) --body "$(COMMENT)"
issue-close: ## Close an issue (requires NUM)
@if [ -z "$(NUM)" ]; then \
echo "Error: NUM is required"; \
echo "Usage: make issue-close NUM=123"; \
exit 1; \
fi
@gh issue close $(NUM) --repo $(REPO)
# Advanced: Add issue to project (requires ISSUE_URL)
add-to-project: ## Add an issue to the project (requires ISSUE_URL)
@if [ -z "$(ISSUE_URL)" ]; then \
echo "Error: ISSUE_URL is required"; \
echo "Usage: make add-to-project ISSUE_URL=https://github.com/darrenhinde/OpenAgents/issues/123"; \
exit 1; \
fi
@gh project item-add $(PROJECT_NUMBER) --owner $(OWNER) --url "$(ISSUE_URL)"
# Quick shortcuts
.PHONY: new list open high-priority
new: idea ## Alias for 'idea'
list: ideas ## Alias for 'ideas'
open: board ## Alias for 'board'
high-priority: ## List all high priority items
@make by-priority PRIORITY=high
# =============================================================================
# Evaluation Framework Commands
# =============================================================================
build-evals: ## Build the evaluation framework
@echo "🔨 Building evaluation framework..."
@cd evals/framework && npm ci && npm run build
@echo "✅ Build complete"
validate-evals: ## Validate all test suites
@echo "🔍 Validating test suites..."
@cd evals/framework && npm run validate:suites:all
@echo "✅ Validation complete"
test-golden: ## Run golden tests (8 tests, ~3-5 min)
@echo "🧪 Running golden tests..."
@cd evals/framework && npm run eval:sdk -- --agent=openagent --pattern="**/golden/*.yaml"
test-smoke: ## Run smoke test only (1 test, ~30s)
@echo "🧪 Running smoke test..."
@cd evals/framework && npm run eval:sdk -- --agent=openagent --pattern="**/golden/01-smoke-test.yaml"
test-verbose: ## Run golden tests with full conversation output
@echo "🧪 Running golden tests (verbose)..."
@cd evals/framework && npm run eval:sdk -- --agent=openagent --pattern="**/golden/*.yaml" --verbose
test-evals: build-evals validate-evals test-golden ## Full eval pipeline: build, validate, test
# Test with specific agent
test-agent: ## Run tests for specific agent (requires AGENT=name)
@if [ -z "$(AGENT)" ]; then \
echo "Error: AGENT is required"; \
echo "Usage: make test-agent AGENT=openagent"; \
echo " make test-agent AGENT=opencoder"; \
exit 1; \
fi
@echo "🧪 Running tests for agent: $(AGENT)..."
@cd evals/framework && npm run eval:sdk -- --agent=$(AGENT) --pattern="**/golden/*.yaml"
# Test with specific model
test-model: ## Run tests with specific model (requires MODEL=provider/model)
@if [ -z "$(MODEL)" ]; then \
echo "Error: MODEL is required"; \
echo "Usage: make test-model MODEL=opencode/grok-code-fast"; \
echo " make test-model MODEL=anthropic/claude-3-5-sonnet-20241022"; \
exit 1; \
fi
@echo "🧪 Running tests with model: $(MODEL)..."
@cd evals/framework && npm run eval:sdk -- --agent=openagent --model=$(MODEL) --pattern="**/golden/*.yaml"
# Test with prompt variant
test-variant: ## Run tests with prompt variant (requires VARIANT=name)
@if [ -z "$(VARIANT)" ]; then \
echo "Error: VARIANT is required"; \
echo "Usage: make test-variant VARIANT=gpt"; \
echo " make test-variant VARIANT=llama"; \
echo "Available: default, gpt, gemini, grok, llama"; \
exit 1; \
fi
@echo "🧪 Running tests with prompt variant: $(VARIANT)..."
@cd evals/framework && npm run eval:sdk -- --agent=openagent --prompt-variant=$(VARIANT) --pattern="**/golden/*.yaml"
# Test subagent standalone
test-subagent: ## Test subagent in standalone mode (requires SUBAGENT=name)
@if [ -z "$(SUBAGENT)" ]; then \
echo "Error: SUBAGENT is required"; \
echo "Usage: make test-subagent SUBAGENT=coder-agent"; \
echo " make test-subagent SUBAGENT=tester"; \
echo ""; \
echo "Available subagents:"; \
echo " Code: coder-agent, tester, reviewer, build-agent"; \
echo " Core: task-manager, documentation, context-retriever"; \
echo " System: agent-generator, command-creator, context-organizer"; \
exit 1; \
fi
@echo "⚡ Testing subagent (standalone mode): $(SUBAGENT)..."
@cd evals/framework && npm run eval:sdk -- --subagent=$(SUBAGENT)
# Test subagent via delegation
test-subagent-delegate: ## Test subagent via parent delegation (requires SUBAGENT=name)
@if [ -z "$(SUBAGENT)" ]; then \
echo "Error: SUBAGENT is required"; \
echo "Usage: make test-subagent-delegate SUBAGENT=coder-agent"; \
echo " make test-subagent-delegate SUBAGENT=tester"; \
exit 1; \
fi
@echo "🔗 Testing subagent (delegation mode): $(SUBAGENT)..."
@cd evals/framework && npm run eval:sdk -- --subagent=$(SUBAGENT) --delegate
# View results
view-results: ## Open results dashboard in browser
@echo "📊 Opening results dashboard..."
@open evals/results/index.html 2>/dev/null || xdg-open evals/results/index.html 2>/dev/null || echo "Open evals/results/index.html in your browser"
# Show latest results
show-results: ## Show latest test results summary
@echo "📊 Latest test results:"
@if [ -f "evals/results/latest.json" ]; then \
echo ""; \
jq -r '"Agent: \(.meta.agent)\nModel: \(.meta.model)\nTimestamp: \(.meta.timestamp)\n\nResults: \(.summary.passed)/\(.summary.total) passed (\(.summary.pass_rate * 100 | floor)%)\nDuration: \(.summary.duration_ms)ms"' evals/results/latest.json; \
echo ""; \
echo "Tests:"; \
jq -r '.tests[] | " \(if .passed then "✅" else "❌" end) \(.id) (\(.duration_ms)ms)"' evals/results/latest.json; \
else \
echo "No results found. Run 'make test-golden' first."; \
fi