OpenWriterControle/scripts
Darren Hinde 784ffadf92
chore: verify and stabilize main branch (#42)
* chore: update package-lock.json after npm install

* chore: remove unused ajv-cli, keep vitest at stable 1.6.1

- Removed ajv-cli (unused dev dependency, had high severity vulnerability)
- Kept vitest at 1.6.1 (stable, upgrading to v4 requires extensive refactoring)
- Reduced vulnerabilities from 6 to 4 (all moderate, dev-only)
- All remaining vulnerabilities are in esbuild/vite (dev server only, no production impact)
- Build and tests verified working

* feat(evals): add execution-balance validation to 21 OpenAgent tests and enhance agent system

Major improvements to evaluation framework and agent capabilities:

## Execution Balance Evaluator Integration
- Added execution-balance rule to 21 OpenAgent tests (2.7% → 31.5% coverage)
- Validates "read before execute" pattern across critical rules, workflows, and edge cases
- Tests now check: read operations before execution tools, healthy read/exec ratio (≥1.0)
- Coverage includes: approval-gate, context-loading, stop-on-failure, report-first tests

## Agent System Enhancements
- Enhanced OpenCoder agent with critical rules enforcement (approval gates, context loading)
- Added structured delegation rules and workflow phases
- Improved error handling with REPORT→PROPOSE→REQUEST→FIX pattern

## New Agent Creation System
- Added research-backed agent creation templates and guides
- Includes 8 test templates covering planning, context, incremental execution, tools
- Automated agent scaffolding with /create-agent command
- Complete documentation in .opencode/command/openagents/new-agents/

## OpenCoder Test Suite
- Added 8 comprehensive test cases for OpenCoder agent
- Tests cover: planning, context-loading, delegation, error-handling, implementation
- Includes DEBUG_GUIDE.md and QUICK_TEST_GUIDE.md for developers

## Documentation & Tooling
- Added DEVELOPMENT.md guide for contributors
- Enhanced CONTRIBUTING.md with quick reference and common commands
- Improved event-logger with DEBUG_VERBOSE mode for detailed output
- Added debug scripts: show-test-conversation.sh, run-test-verbose.sh
- Removed deprecated EXTERNAL_PR_GUIDE.md

## Version Bump
- Bumped version to 0.0.3 (patch)

Files changed: 60+ files (21 test updates, 16 new agent templates, 8 new tests, docs, tooling)

* feat(ci): add PR title validation for semantic versioning

Add automated PR title validation to ensure conventional commit format.
This enables proper automatic version bumping when PRs are merged.

Features:
- Validates PR titles against conventional commit patterns
- Shows expected version bump (major/minor/patch)
- Posts helpful comment with examples if validation fails
- Supports all conventional commit types (feat, fix, docs, etc.)
- Supports breaking changes (feat!, fix!)
- Supports pre-release tags ([alpha], [beta], [rc])

When PR titles follow the format, version bumping works correctly:
- feat: → minor bump (0.3.0 → 0.4.0)
- fix: → patch bump (0.3.0 → 0.3.1)
- feat!: → major bump (0.3.0 → 1.0.0)

* fix(ci): improve PR checks workflow with sequential execution

Reorganize PR checks to run in logical sequence and skip unnecessary checks:

Changes:
- Run PR title validation first (fast, always required)
- Detect changed files to determine which checks to run
- Only run build checks if evals/ files changed
- Add comprehensive summary job showing all check results
- Prevent cache errors when evals files not changed

Benefits:
- Faster PR checks (skip unnecessary builds)
- Clear sequential execution (title → changes → build)
- Better error messages and summaries
- Reduced CI/CD costs

* fix(ci): resolve PR #42 issues and refactor prompt architecture

## Fixed PR #42 Issues

1. **Prompt Validation** - Refactored to new architecture where agent files are canonical defaults
2. **Package-lock.json** - Fixed workflow to use root package-lock (npm workspaces)
3. **Git Merge Base** - Added fetch-depth: 0 to PR checks workflow

## New Prompt Architecture

**Before:**
- Agent files had to match .opencode/prompts/<agent>/default.md
- Caused validation failures when updating prompts
- Redundant duplication

**After:**
- Agent files (.opencode/agent/*.md) = Canonical defaults (source of truth)
- Prompt variants (.opencode/prompts/<agent>/<model>.md) = Model-specific optimizations
- No more default.md files needed

## Changes

### Workflows
- pr-checks.yml: Added fetch-depth: 0 for full git history
- validate-test-suites.yml: Fixed package-lock path for npm workspaces
- validate-registry.yml: Updated validation messaging

### Scripts
- validate-pr.sh: Validates prompt library structure (rejects default.md files)
- use-prompt.sh: Handles 'default' as agent file, variants as model-specific
- test-prompt.sh: Tests default variant correctly, saves results to prompts/results/

### Documentation
- .opencode/prompts/README.md: Updated architecture explanation
- docs/contributing/CONTRIBUTING.md: Updated prompt workflow
- scripts/development/demo.sh: Updated structure display

## Results

- 12 files changed, 231 insertions(+), 811 deletions(-)
- Net reduction: 580 lines (cleaner codebase)
- All validations passing
- Results directory structure preserved
- Backwards compatible with existing test results
2025-12-09 13:26:52 +00:00
..
check-context-logs feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
development chore: verify and stabilize main branch (#42) 2025-12-09 13:26:52 +00:00
docs feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
maintenance feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
prompts chore: verify and stabilize main branch (#42) 2025-12-09 13:26:52 +00:00
registry feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
testing feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
tests refactor: simplify agent execution philosophy and reorganize context structure 2025-11-19 13:13:06 +00:00
validation feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
versioning feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00
README.md feat: add PR template and automated doc sync workflow (#40) 2025-12-08 22:27:01 +00:00

Scripts

This directory contains utility scripts for the OpenAgents system, organized by function.

Directory Structure

scripts/
├── registry/              # Component registry management
│   ├── auto-detect-components.sh
│   ├── register-component.sh
│   ├── validate-component.sh
│   └── validate-registry.sh
├── validation/            # Context and validation scripts
│   └── validate-context-refs.sh
├── versioning/            # Version management
│   └── bump-version.sh
├── maintenance/           # Cleanup and maintenance
│   ├── cleanup-stale-sessions.sh
│   └── uninstall.sh
├── development/           # Development utilities
│   ├── dashboard.sh
│   └── demo.sh
├── testing/               # Test runner
│   └── test.sh
├── check-context-logs/    # Context logging utilities
├── prompts/               # Prompt management
└── tests/                 # Installer test scripts

Available Scripts

Testing

  • testing/test.sh - Main test runner with multi-agent support
    • Run all tests: ./scripts/testing/test.sh openagent
    • Run core tests: ./scripts/testing/test.sh openagent --core (7 tests, ~5-8 min)
    • Run with specific model: ./scripts/testing/test.sh openagent opencode/grok-code-fast
    • Debug mode: ./scripts/testing/test.sh openagent --core --debug

See tests/ subdirectory for installer test scripts.

Registry Management

  • registry/auto-detect-components.sh - Auto-detect new components in .opencode/
  • registry/register-component.sh - Register a new component in the registry
  • registry/validate-component.sh - Validate component structure and metadata
  • registry/validate-registry.sh - Validate all registry paths

Validation

  • validation/validate-context-refs.sh - Validate context references in markdown files

Versioning

  • versioning/bump-version.sh - Bump version (alpha, beta, rc, patch, minor, major)

Maintenance

  • maintenance/cleanup-stale-sessions.sh - Remove stale agent sessions older than 24 hours
  • maintenance/uninstall.sh - Uninstall OpenCode agents

Development

  • development/demo.sh - Interactive demo of repository structure
  • development/dashboard.sh - Launch test results dashboard

Session Cleanup

Agent instances create temporary context files in .tmp/sessions/{session-id}/ for subagent delegation. These sessions are automatically cleaned up, but you can manually remove stale sessions:

# Clean up sessions older than 24 hours
./scripts/maintenance/cleanup-stale-sessions.sh

# Or manually delete all sessions
rm -rf .tmp/sessions/

Sessions are safe to delete anytime - they only contain temporary context files for agent coordination.

Usage Examples

Run Tests

# Run core test suite (fast, 7 tests, ~5-8 min)
./scripts/testing/test.sh openagent --core

# Run all tests for OpenAgent
./scripts/testing/test.sh openagent

# Run tests with specific model
./scripts/testing/test.sh openagent anthropic/claude-sonnet-4-5

# Run core tests with debug mode
./scripts/testing/test.sh openagent --core --debug

Registry Management

# Auto-detect new components
./scripts/registry/auto-detect-components.sh --dry-run

# Add new components to registry
./scripts/registry/auto-detect-components.sh --auto-add

# Validate registry
./scripts/registry/validate-registry.sh -v

# Register a specific component
./scripts/registry/register-component.sh path/to/component

# Validate a component
./scripts/registry/validate-component.sh path/to/component

Maintenance

# Clean stale sessions
./scripts/maintenance/cleanup-stale-sessions.sh

# Uninstall OpenCode agents
./scripts/maintenance/uninstall.sh

Development

# Run interactive demo
./scripts/development/demo.sh

# Launch test results dashboard
./scripts/development/dashboard.sh

Versioning

# Bump version
./scripts/versioning/bump-version.sh patch
./scripts/versioning/bump-version.sh minor
./scripts/versioning/bump-version.sh major
./scripts/versioning/bump-version.sh alpha

Core Test Suite

The core test suite is a subset of 7 carefully selected tests that provide ~85% coverage of critical OpenAgent functionality in just 5-8 minutes.

Why Use Core Tests?

  • ✅ Fast feedback - 5-8 minutes vs 40-80 minutes for full suite
  • ✅ Prompt iteration - Quick validation when updating agent prompts
  • ✅ Development - Fast validation during development cycles
  • ✅ Pre-commit - Quick checks before committing changes

What's Covered?

  1. Approval Gate - Critical safety rule
  2. Context Loading (Simple) - Most common use case
  3. Context Loading (Multi-Turn) - Complex scenarios
  4. Stop on Failure - Error handling
  5. Simple Task - No unnecessary delegation
  6. Subagent Delegation - Proper delegation when needed
  7. Tool Usage - Best practices

When to Use Full Suite?

Use the full test suite (71 tests) for:

  • 🔬 Release validation
  • 🔬 Comprehensive testing
  • 🔬 Edge case coverage
  • 🔬 Regression testing

See evals/agents/openagent/CORE_TESTS.md for detailed documentation.