c8f7103cb6
* 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
289 lines
4.4 KiB
Markdown
289 lines
4.4 KiB
Markdown
# Guide: Creating a Release
|
|
|
|
**Purpose**: Step-by-step workflow for creating a new release
|
|
|
|
---
|
|
|
|
## Quick Steps
|
|
|
|
```bash
|
|
# 1. Update version
|
|
echo "0.X.Y" > VERSION
|
|
jq '.version = "0.X.Y"' package.json > tmp && mv tmp package.json
|
|
|
|
# 2. Update CHANGELOG
|
|
# (Edit CHANGELOG.md manually)
|
|
|
|
# 3. Commit and tag
|
|
git add VERSION package.json CHANGELOG.md
|
|
git commit -m "chore: bump version to 0.X.Y"
|
|
git tag -a v0.X.Y -m "Release v0.X.Y"
|
|
|
|
# 4. Push
|
|
git push origin main
|
|
git push origin v0.X.Y
|
|
```
|
|
|
|
---
|
|
|
|
## Step 1: Determine Version
|
|
|
|
### Semantic Versioning
|
|
|
|
```
|
|
MAJOR.MINOR.PATCH
|
|
|
|
- MAJOR: Breaking changes
|
|
- MINOR: New features (backward compatible)
|
|
- PATCH: Bug fixes
|
|
```
|
|
|
|
### Examples
|
|
|
|
- `0.5.0` → `0.5.1` (bug fix)
|
|
- `0.5.0` → `0.6.0` (new feature)
|
|
- `0.5.0` → `1.0.0` (breaking change)
|
|
|
|
---
|
|
|
|
## Step 2: Update Version Files
|
|
|
|
### VERSION File
|
|
|
|
```bash
|
|
echo "0.X.Y" > VERSION
|
|
```
|
|
|
|
### package.json
|
|
|
|
```bash
|
|
jq '.version = "0.X.Y"' package.json > tmp && mv tmp package.json
|
|
```
|
|
|
|
### Verify Consistency
|
|
|
|
```bash
|
|
cat VERSION
|
|
cat package.json | jq '.version'
|
|
# Both should show same version
|
|
```
|
|
|
|
---
|
|
|
|
## Step 3: Update CHANGELOG
|
|
|
|
### Format
|
|
|
|
```markdown
|
|
# Changelog
|
|
|
|
## [0.X.Y] - 2025-12-10
|
|
|
|
### Added
|
|
- New feature 1
|
|
- New feature 2
|
|
|
|
### Changed
|
|
- Updated feature 1
|
|
- Improved feature 2
|
|
|
|
### Fixed
|
|
- Bug fix 1
|
|
- Bug fix 2
|
|
|
|
### Removed
|
|
- Deprecated feature 1
|
|
|
|
## [Previous Version] - Date
|
|
...
|
|
```
|
|
|
|
### Tips
|
|
|
|
✅ **Group by type** - Added, Changed, Fixed, Removed
|
|
✅ **User-focused** - Describe impact, not implementation
|
|
✅ **Link PRs** - Reference PR numbers
|
|
✅ **Breaking changes** - Clearly mark breaking changes
|
|
|
|
---
|
|
|
|
## Step 4: Commit Changes
|
|
|
|
```bash
|
|
# Stage files
|
|
git add VERSION package.json CHANGELOG.md
|
|
|
|
# Commit
|
|
git commit -m "chore: bump version to 0.X.Y"
|
|
```
|
|
|
|
---
|
|
|
|
## Step 5: Create Git Tag
|
|
|
|
```bash
|
|
# Create annotated tag
|
|
git tag -a v0.X.Y -m "Release v0.X.Y"
|
|
|
|
# Verify tag
|
|
git tag -l "v0.X.Y"
|
|
git show v0.X.Y
|
|
```
|
|
|
|
---
|
|
|
|
## Step 6: Push to GitHub
|
|
|
|
```bash
|
|
# Push commit
|
|
git push origin main
|
|
|
|
# Push tag
|
|
git push origin v0.X.Y
|
|
```
|
|
|
|
---
|
|
|
|
## Step 7: Create GitHub Release
|
|
|
|
### Via GitHub UI
|
|
|
|
1. Go to repository on GitHub
|
|
2. Click "Releases"
|
|
3. Click "Create a new release"
|
|
4. Select tag: `v0.X.Y`
|
|
5. Title: `v0.X.Y`
|
|
6. Description: Copy from CHANGELOG
|
|
7. Click "Publish release"
|
|
|
|
### Via GitHub CLI
|
|
|
|
```bash
|
|
gh release create v0.X.Y \
|
|
--title "v0.X.Y" \
|
|
--notes "$(cat CHANGELOG.md | sed -n '/## \[0.X.Y\]/,/## \[/p' | head -n -1)"
|
|
```
|
|
|
|
---
|
|
|
|
## Step 8: Verify Release
|
|
|
|
### Check GitHub
|
|
|
|
- ✅ Release appears on GitHub
|
|
- ✅ Tag is correct
|
|
- ✅ CHANGELOG is included
|
|
- ✅ Assets are attached (if any)
|
|
|
|
### Test Installation
|
|
|
|
```bash
|
|
# Test install from GitHub
|
|
./install.sh --list
|
|
|
|
# Verify version
|
|
cat VERSION
|
|
```
|
|
|
|
---
|
|
|
|
## Complete Example
|
|
|
|
```bash
|
|
# Releasing v0.6.0
|
|
|
|
# 1. Update version
|
|
echo "0.6.0" > VERSION
|
|
jq '.version = "0.6.0"' package.json > tmp && mv tmp package.json
|
|
|
|
# 2. Update CHANGELOG
|
|
cat >> CHANGELOG.md << 'EOF'
|
|
## [0.6.0] - 2025-12-10
|
|
|
|
### Added
|
|
- New API specialist agent
|
|
- GraphQL support in backend specialist
|
|
|
|
### Changed
|
|
- Improved eval framework performance
|
|
- Updated registry schema to 2.0.0
|
|
|
|
### Fixed
|
|
- Fixed path resolution for subagents
|
|
- Fixed registry validation edge cases
|
|
EOF
|
|
|
|
# 3. Commit
|
|
git add VERSION package.json CHANGELOG.md
|
|
git commit -m "chore: bump version to 0.6.0"
|
|
|
|
# 4. Tag
|
|
git tag -a v0.6.0 -m "Release v0.6.0"
|
|
|
|
# 5. Push
|
|
git push origin main
|
|
git push origin v0.6.0
|
|
|
|
# 6. Create GitHub release
|
|
gh release create v0.6.0 \
|
|
--title "v0.6.0" \
|
|
--notes "See CHANGELOG.md for details"
|
|
```
|
|
|
|
---
|
|
|
|
## Checklist
|
|
|
|
Before releasing:
|
|
|
|
- [ ] All tests pass
|
|
- [ ] Registry validates
|
|
- [ ] VERSION updated
|
|
- [ ] package.json updated
|
|
- [ ] CHANGELOG updated
|
|
- [ ] Changes committed
|
|
- [ ] Tag created
|
|
- [ ] Pushed to GitHub
|
|
- [ ] GitHub release created
|
|
- [ ] Installation tested
|
|
|
|
---
|
|
|
|
## Common Issues
|
|
|
|
### Version Mismatch
|
|
|
|
**Problem**: VERSION and package.json don't match
|
|
**Solution**: Update both to same version
|
|
|
|
### Tag Already Exists
|
|
|
|
**Problem**: Tag already exists
|
|
**Solution**: Delete tag and recreate
|
|
```bash
|
|
git tag -d v0.X.Y
|
|
git push origin :refs/tags/v0.X.Y
|
|
```
|
|
|
|
### Push Rejected
|
|
|
|
**Problem**: Push rejected (not up to date)
|
|
**Solution**: Pull latest changes first
|
|
```bash
|
|
git pull origin main
|
|
git push origin main
|
|
git push origin v0.X.Y
|
|
```
|
|
|
|
---
|
|
|
|
## Related Files
|
|
|
|
- **Version management**: `scripts/versioning/bump-version.sh`
|
|
- **CHANGELOG**: `CHANGELOG.md`
|
|
- **VERSION**: `VERSION`
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-12-10
|
|
**Version**: 0.5.0
|