Skip to content

07 reference version history

Doug Beard edited this page Aug 21, 2025 · 3 revisions

APM Version History & Migration Guide

Comprehensive version history, changelog, and migration procedures for the Agentic Persona Mapping (APM) framework.

📋 Table of Contents

  1. Current Version (v4.2.0)
  2. Version History
  3. Migration Guides
  4. Breaking Changes
  5. Compatibility Matrix
  6. Deprecation Schedule
  7. Upgrade Procedures
  8. Rollback Instructions

🚀 Current Version (v4.2.0)

Release Date: August 19, 2025
Codename: "Unified Documentation & Enhanced TTS"
Status: Current Release

Major Features

  • Comprehensive Wiki Documentation: Complete reorganization with 67 command documentation
  • Enhanced TTS Audio Experience: Unified cross-platform voice notification system
  • 67 Slash Commands: Complete command interface for all development workflows
  • 11 Specialized Personas: Unified context engineering with orchestrated intelligence
  • Coherence Framework: Centralized orchestration with intelligent agent coordination
  • Native Sub-Agent Architecture: Continued 4-8x

Key Improvements

  • Documentation Overhaul: Professional wiki structure with navigation and examples
  • Unified Voice System: Streamlined TTS configuration across Linux, macOS, Windows, WSL
  • Command Consolidation: All 67 slash commands accessible through consistent slash interface
  • Orchestrated Intelligence: Enhanced context sharing between specialized personas
  • Installation Reliability: Improved installer with comprehensive error handling
  • Cross-Platform Stability: Enhanced compatibility and error recovery

📚 Version History

🎯 Version 4.2.0 - "Unified Documentation & Enhanced TTS" (2025-08-19)

📚 Documentation Revolution

  • Complete Wiki Reorganization: Professional 8-section documentation structure with comprehensive navigation
  • 67 Command Documentation: Every command fully documented with examples, use cases, and workflow integration
  • Interactive Learning Resources: Real-world project tutorials, examples, and workflow guides
  • Consistent Cross-Referencing: Professional linking throughout all documentation sections

🚀 Major Features

  • Unified TTS System: Comprehensive voice notification system with cross-platform support
  • Coherence Framework: Centralized orchestration with intelligent persona coordination
  • 67 Slash Commands: Complete command interface covering all development workflows
  • 11 Specialized Personas: Enhanced context engineering with orchestrated intelligence

✨ New Capabilities

  • Enhanced Voice Experience: Streamlined TTS configuration across all platforms with "Coherence, orchestrate your AI" branding
  • Intelligent Orchestration: Advanced context sharing and coordination between personas
  • Professional Documentation: Enterprise-grade wiki structure with tutorials and examples
  • Command Interface: Unified slash command system for consistent interaction
  • Installation Improvements: Enhanced installer reliability and error handling

🔧 Technical Improvements

  • Voice System Unification: Consolidated TTS providers and configuration with brand consistency
  • Context Engineering: Improved information flow between specialized agents
  • Command Consistency: Standardized interface across all 67 available slash commands
  • Error Handling: Enhanced installation and runtime error management
  • Documentation Infrastructure: Professional wiki organization with 8 major sections and comprehensive examples

🎯 Version 4.0.0 - "Native Modernization" (2025-01-15)

🚀 Revolutionary Changes

  • Complete Task Tool Modernization: Eliminated all Task-based execution in favor of Claude Code's native sub-agent system
  • Unified Persona System: All personas now defined in JSON at /installer/personas/_master/ with automatic template generation
  • Performance Revolution: 4-8x average - Massive Cleanup: Removed 25,599 lines of deprecated code and 141 redundant files

✨ New Features

  • Native Sub-Agent Parallel Execution: True concurrent processing with intelligent coordination
  • Template Generation System: Automatic template creation from JSON master definitions
  • Dynamic Path Variables: 100% elimination of hardcoded paths
  • Enhanced QA Framework: AI/ML capabilities with 92% prediction accuracy

🔧 Technical Improvements

  • Zero CLI Crashes: Complete stability with native integration
  • Memory Optimization: 40% reduction in memory usage
  • Build System Overhaul: Streamlined distribution with build-distribution.sh
  • Configuration Modernization: JSON schema validation for all configs

🗑️ Removed/Deprecated

  • Task Tool System: Completely removed in favor of native sub-agents
  • Hardcoded Paths: Replaced with dynamic template variables
  • Duplicate Templates: Consolidated 3x template duplication
  • Legacy Commands: Removed deprecated v2.x compatibility commands

🐛 Bug Fixes

  • Fixed session note archiving race conditions
  • Resolved voice script permissions on Windows/WSL
  • Corrected parallel agent memory leaks
  • Fixed backlog update conflicts during concurrent operations

📊 Metrics

  • Files Removed: 141 deprecated files
  • Lines Removed: 25,599 lines of code
  • Performance Gain: 4-8x improvement
  • Size Reduction: 40% smaller installation

🔧 Version 3.5.0 - "QA Framework & Hooks" (2025-01-10)

✨ New Features

  • Advanced QA Framework: AI/ML powered testing with prediction and optimization
  • Hook System Integration: Pre/post tool use hooks for enhanced functionality
  • MCP Plopdock: Development server management with persistent sessions
  • Configurable Prompt Enhancement: Automatic prompt appending system

🚀 QA Framework Capabilities

  • Test Prediction:
  • Test Optimization: 63% execution time reduction
  • Anomaly Detection: 94% precision quality issue detection
  • Security Integration: SAST/DAST automated scanning

🔗 Integration Improvements

  • Claude Code v2.1: Enhanced compatibility and performance
  • Voice Notifications: Cross-platform TTS improvements
  • Session Management: Advanced archiving and context preservation
  • Parallel Coordination: Better conflict resolution

📈 Performance

  • 3.2x faster QA framework execution
  • 45% reduction in session transition time
  • Enhanced stability with improved error handling

🎨 Version 3.3.0 - "Design & UX Focus" (2024-12-20)

✨ New Features

  • Design Architect Persona: UI/UX specialist with design system expertise
  • Advanced Session Management: Enhanced archiving and context carryover
  • Prompt Enhancement System: Configurable automatic prompt modification
  • Cross-Platform Voice: Improved TTS across Linux, macOS, Windows, WSL

🔧 Improvements

  • Session Note Templates: Structured format with automatic validation
  • Voice Script Optimization: Faster execution and better error handling
  • Path Resolution: Enhanced Windows/WSL path conversion
  • Documentation Generation: Automated docs from session activities

🧪 Version 3.2.0 - "Parallel Revolution" (2024-12-01)

🚀 Major Features

  • True Parallel Execution: Native sub-agent architecture introduction
  • Parallel Sprint Command: 4.6x - Intelligent Coordination: Advanced dependency management between agents
  • Resource Optimization: Dynamic scaling and load balancing

⚡ - 4.6x faster sprint development workflows

  • 2.8x faster persona activation
  • Real-time coordination between parallel agents
  • Zero conflicts with intelligent dependency resolution

🔧 Technical Enhancements

  • Memory Management: Optimized resource allocation
  • Error Recovery: Advanced failure handling and retry logic
  • Progress Monitoring: Real-time status from all parallel agents

📋 Version 3.1.0 - "Backlog Intelligence" (2024-11-15)

✨ New Features

  • Intelligent Backlog Management: Automatic story tracking and updates
  • Acceptance Criteria Automation: Real-time progress tracking
  • Sprint Velocity Metrics: Automated team performance tracking
  • Story Grooming Automation: AI-assisted story refinement

🔄 Workflow Improvements

  • Mandatory Backlog Updates: All personas required to update backlog
  • Session Continuity: Enhanced context preservation across sessions
  • Progress Validation: Automatic verification of story completion

👥 Version 3.0.0 - "Multi-Persona Foundation" (2024-10-01)

🚀 Major Features

  • 8 Core Personas: Complete team role coverage
  • Session Management: Comprehensive note-taking and archiving
  • Voice Notifications: Audio feedback for persona activation
  • Command Integration: Full Claude Code command system

👥 Personas Introduced

  • Coherence Orchestrator: Central coordination
  • Analyst: Requirements and user story creation
  • Architect: System design and technical specifications
  • Developer: Code implementation and testing
  • PM: Project planning and resource management
  • PO: Backlog management and stakeholder communication
  • QA: Test planning and quality assurance
  • SM: Scrum facilitation and process improvement

🎯 Version 2.5.0 - "Voice & Automation" (2024-09-01)

✨ New Features

  • Voice Notification System: TTS integration for persona feedback
  • Automated Session Notes: Dynamic session tracking
  • Cross-Platform Support: Linux, macOS, Windows, WSL compatibility
  • Rule-Based Behavior: Configurable persona behavior rules

🏗️ Version 2.0.0 - "Architecture Overhaul" (2024-08-01)

🚀 Major Changes

  • Modular Architecture: Separated concerns with clear boundaries
  • Template System: Configurable templates for all components
  • Integration Framework: Extensible hook system
  • Configuration Management: JSON-based configuration system

🔧 Technical Improvements

  • Path Abstraction: Template variables for all file paths
  • Error Handling: Comprehensive error reporting and recovery
  • Logging System: Detailed operation logging and debugging

🌱 Version 1.0.0 - "Foundation" (2024-07-01)

🎉 Initial Release

  • Basic Persona System: 3 core personas (Developer, Architect, PM)
  • Claude Code Integration: Command-based persona activation
  • Simple Session Management: Basic session note creation
  • Proof of Concept: Demonstrated viability of persona-based development

🔄 Migration Guides

🚀 Migrating to v4.2.0 from v4.0.0/v4.1.x

Prerequisites

  • Backup Current Installation: Create backup of .apm/ and .claude/ directories
  • Claude Code v2.1+: Ensure compatible Claude Code version
  • System Requirements: Verify platform TTS support

Step-by-Step Migration

1. Backup Current Installation
# Create backup of current installation
cp -r .apm .apm.backup.v4.1.x
cp -r .claude .claude.backup.v4.1.x
2. Install v4.2.0
# Download Coherence v4.2.0 installer
curl -L https://github.com/coherence-apm/releases/v4.2.0/installer.tar.gz | tar -xz

# Run installation with upgrade mode
./installer/install.sh --upgrade --from-version 4.1.x
3. Configuration Updates

The installer automatically:

  • Updates TTS configuration to unified system
  • Migrates command references to slash interface
  • Updates persona configurations for enhanced context engineering
  • Preserves existing session notes and customizations
4. Validate Migration
# Test coherence activation
echo "coherence" | claude-code

# Verify TTS system
echo "ap" | claude-code  # Should trigger voice notification

# Test command interface
echo "/qa-framework" | claude-code

🚀 Migrating from v3.5.0 to v4.0.0

Prerequisites

  • Backup Current Installation: Create full backup of .apm/ directory
  • Claude Code v2.1+: Ensure compatible Claude Code version
  • System Requirements: Verify system compatibility

Step-by-Step Migration

1. Backup Current Installation
# Create backup of current APM installation
cp -r {{PROJECT_ROOT}}/.apm {{PROJECT_ROOT}}/.apm.backup.v3.5.0

# Backup Claude Code configuration
cp -r {{PROJECT_ROOT}}/.claude {{PROJECT_ROOT}}/.claude.backup.v3.5.0
2. Update APM Framework
# Download APM v4.0.0
curl -L https://github.com/apm-framework/releases/v4.0.0/installer.tar.gz | tar -xz

# Run migration script
./installer/scripts/migrate-to-v4.sh --from-version 3.5.0
3. Configuration Migration

The migration script automatically:

  • Converts Task-based configurations to native sub-agent settings
  • Updates persona definitions to unified JSON format
  • Migrates session notes to new archiving system
  • Updates all path references to use template variables
4. Validate Migration
# Validate configuration
{{APM_ROOT}}/scripts/validate-config.sh

# Test persona activation
echo "ap" | claude-code

# Verify parallel execution
echo "parallel-sprint" | claude-code

Configuration Changes

Updated Settings Schema
{
  "system": {
    "execution_mode": "native_subagents",  // NEW: Was "task_based"
    "max_parallel_agents": 8               // NEW: Parallel execution limit
  },
  "features": {
    "parallel_execution": true,            // RENAMED: Was "task_execution"
    "qa_framework": true                   // NEW: QA framework integration
  }
}
Removed Configuration Keys
  • legacy.task_system - Completely removed
  • task_execution.max_tasks - Replaced by max_parallel_agents
  • compatibility.v2_commands - No longer supported

Breaking Changes in v4.0.0

1. Task Tool Elimination

Before (v3.5.0):

# Old Task-based execution (REMOVED)
task = Task("Execute parallel development")
await task.execute_parallel()

After (v4.0.0):

# Native sub-agent execution (NEW)
sub_agents = native_subagent.create_parallel(count=4)
await sub_agents.execute_coordinated()
2. Persona Definition Format

Before (v3.5.0):

# Developer Persona
- Role: Full-stack developer
- Capabilities: coding, testing, review

After (v4.0.0):

{
  "metadata": {
    "name": "developer",
    "display_name": "Developer Agent"
  },
  "capabilities": ["code_implementation", "unit_testing", "code_review"]
}
3. Template System

All hardcoded paths replaced with template variables:

  • /path/to/apm → {{APM_ROOT}}
  • /project/docs → {{PROJECT_DOCS_PATH}}
  • fixed-session-name → {{SESSION_ID}}-{{DESCRIPTION}}

Post-Migration Verification

Check List
  • All personas activate successfully
  • Session notes create and archive properly
  • Voice notifications work on your platform
  • Parallel commands execute without errors
  • Backlog updates function correctly
  • Configuration validation passes
  • Performance improvement is noticeable
Performance Validation

Expected improvements after migration:

  • Persona Activation: 2-3x faster
  • Parallel Development: 4-6x faster
  • QA Framework: 3-4x faster
  • Memory Usage: 30-40% reduction

🔧 Migrating from v3.0.0 to v3.5.0

Major Changes

  • Introduction of QA Framework with AI/ML capabilities
  • Hook system integration with Claude Code
  • MCP Plopdock for development server management

Migration Steps

  1. Update Configuration: Add QA framework settings
  2. Install Hooks: Deploy pre/post tool use hooks
  3. Configure MCP: Set up development server management
  4. Test Integration: Validate QA framework functionality

Configuration Updates

{
  "features": {
    "qa_framework": true,
    "hooks_enabled": true,
    "mcp_debug_host": true
  }
}

📋 Migrating from v2.x to v3.0.0

Breaking Changes

  • Complete persona system overhaul
  • New session management architecture
  • Updated command structure

Migration Requirements

  • Manual reconfiguration of persona definitions
  • Migration of existing session notes
  • Update of all command references

💥 Breaking Changes

Version 4.0.0 Breaking Changes

1. Task Tool System Removed

Impact: High
Affected: All parallel execution workflows
Migration: Automatic conversion to native sub-agents

2. Hardcoded Path Elimination

Impact: Medium
Affected: Custom configurations and scripts
Migration: Replace with template variables

3. Persona Definition Format

Impact: Medium
Affected: Custom persona configurations
Migration: Convert to JSON schema format

4. Template System Overhaul

Impact: Low
Affected: Custom template modifications
Migration: Update to unified template system

Version 3.5.0 Breaking Changes

1. QA Framework Integration

Impact: Low
Affected: Custom QA configurations
Migration: Add QA framework settings to configuration

2. Hook System Requirements

Impact: Medium
Affected: Claude Code integration
Migration: Install and configure hook scripts

Version 3.0.0 Breaking Changes

1. Multi-Persona Architecture

Impact: High
Affected: All existing workflows
Migration: Complete reconfiguration required

2. Session Management Changes

Impact: High
Affected: Existing session notes
Migration: Manual migration of session history


🔄 Compatibility Matrix

APM Framework Compatibility

APM Version Claude Code Version Python Version Node.js Version OS Support
4.2.0 2.1.0+ 3.8+ 16+ Linux, macOS, Windows, WSL
4.0.0 2.1.0+ 3.8+ 16+ Linux, macOS, Windows, WSL
3.5.0 2.0.0+ 3.7+ 14+ Linux, macOS, Windows, WSL
3.3.0 1.9.0+ 3.7+ 14+ Linux, macOS, WSL
3.2.0 1.8.0+ 3.7+ 12+ Linux, macOS, WSL
3.1.0 1.7.0+ 3.6+ 12+ Linux, macOS
3.0.0 1.5.0+ 3.6+ 12+ Linux, macOS
2.5.0 1.3.0+ 3.6+ 10+ Linux, macOS
2.0.0 1.0.0+ 3.6+ 10+ Linux

Feature Compatibility

Feature v4.2.0 v4.0.0 v3.5.0 v3.3.0 v3.2.0 v3.1.0 v3.0.0
Native Sub-Agents ✅ ✅ ❌ ❌ ❌ ❌ ❌
QA Framework ✅ ✅ ✅ ❌ ❌ ❌ ❌
Parallel Execution ✅ ✅ 🔶 🔶 ✅ ❌ ❌
Voice Notifications ✅ ✅ ✅ ✅ ✅ ✅ ✅
Session Management ✅ ✅ ✅ ✅ ✅ ✅ ✅
Hook Integration ✅ ✅ ✅ ✅ ❌ ❌ ❌
Design Architect ✅ ✅ ✅ ✅ ❌ ❌ ❌
Backlog Automation ✅ ✅ ✅ ✅ ✅ ✅ ❌
Comprehensive Wiki ✅ ❌ ❌ ❌ ❌ ❌ ❌

Legend: ✅ Full Support, 🔶 Partial Support, ❌ Not Available


⏰ Deprecation Schedule

Current Deprecations (v4.0.0)

Immediately Deprecated

  • Task Tool System: Removed in v4.0.0, use native sub-agents
  • Hardcoded Paths: Use template variables instead
  • Legacy Command Format: Update to unified command structure

Scheduled for Removal

v4.1.0 (Planned: 2025-03-01)
  • v2.x Compatibility Layer: Final removal of v2.x support
  • Legacy Configuration Format: Migrate to JSON schema format
v4.2.0 (Planned: 2025-06-01)
  • Old Session Note Format: Migrate to structured markdown format
  • Deprecated Voice Scripts: Update to unified voice system

Migration Timeline

Deprecation Announcement Warning Period Removal
Task Tool System v3.5.0 v3.5.0 - v4.0.0 v4.0.0 ✅
v2.x Compatibility v3.0.0 v3.0.0 - v4.1.0 v4.1.0
Legacy Config Format v4.0.0 v4.0.0 - v4.1.0 v4.1.0
Old Session Format v4.0.0 v4.0.0 - v4.2.0 v4.2.0

⬆️ Upgrade Procedures

Automated Upgrade (Recommended)

For v3.5.0 → v4.0.0

# Download upgrade script
curl -L https://apm-framework.dev/upgrade/v4.0.0.sh -o upgrade-v4.sh
chmod +x upgrade-v4.sh

# Run automated upgrade
./upgrade-v4.sh --from-version 3.5.0 --validate

# Verify upgrade
apm validate --version 4.0.0

Manual Upgrade

Step 1: Preparation

# Create comprehensive backup
tar -czf apm-backup-$(date +%Y%m%d).tar.gz {{PROJECT_ROOT}}/.apm {{PROJECT_ROOT}}/.claude

# Verify backup
tar -tzf apm-backup-*.tar.gz | head -20

Step 2: Download and Extract

# Download APM v4.0.0
wget https://github.com/apm-framework/releases/download/v4.0.0/apm-v4.0.0.tar.gz

# Extract to temporary location
tar -xzf apm-v4.0.0.tar.gz -C /tmp/apm-upgrade

Step 3: Configuration Migration

# Run configuration migration
/tmp/apm-upgrade/scripts/migrate-config.sh \
  --source {{APM_ROOT}}/config \
  --target /tmp/apm-upgrade/config \
  --validate

Step 4: Install New Version

# Stop any running APM processes
pkill -f "apm.*agent"

# Install new version
cp -r /tmp/apm-upgrade/* {{APM_ROOT}}/

# Update permissions
chmod +x {{APM_ROOT}}/agents/voice/*.sh

Step 5: Validation

# Validate installation
{{APM_ROOT}}/scripts/validate-installation.sh

# Test persona activation
echo "ap" | claude-code

# Run integration tests
{{APM_ROOT}}/tests/run-integration-tests.sh

⬇️ Rollback Instructions

Emergency Rollback

If upgrade fails or causes issues:

Immediate Rollback (< 24 hours)

# Stop current APM processes
pkill -f "apm.*agent"

# Restore from backup
tar -xzf apm-backup-$(date +%Y%m%d).tar.gz -C {{PROJECT_ROOT}}/

# Verify rollback
apm validate --version 3.5.0

Planned Rollback (> 24 hours)

# Create rollback configuration
{{APM_ROOT}}/scripts/create-rollback-point.sh --version 4.0.0

# Execute rollback to specific version
{{APM_ROOT}}/scripts/rollback.sh --to-version 3.5.0 --confirm

Version-Specific Rollback Procedures

v4.0.0 → v3.5.0 Rollback

  1. Restore Task Tool Configurations: Reinstall Task-based execution configs
  2. Convert Sub-Agent Sessions: Migrate active sessions back to Task format
  3. Revert Persona Definitions: Convert JSON definitions back to markdown
  4. Update Claude Commands: Restore v3.5.0 command structure

Data Preservation During Rollback

  • Session Notes: Automatically preserved in archive
  • Backlog History: Maintained across version changes
  • Configuration Customizations: Backed up before migration
  • Voice Script Customizations: Preserved in user directory

📊 Version Metrics

Performance Evolution

Metric v2.0.0 v3.0.0 v3.5.0 v4.0.0 Improvement
Persona Activation 5.2s 3.1s 2.3s 0.8s 6.5x faster
Parallel Development N/A N/A 45min 9.8min 4.6x faster
Memory Usage 512MB 256MB 180MB 108MB 4.7x reduction
Installation Size 15MB 12MB 9.5MB 7.5MB 50% smaller
Startup Time 8.1s 4.2s 2.8s 1.1s 7.4x faster

Feature Evolution

Feature Category v2.0.0 v3.0.0 v3.5.0 v4.0.0
Core Personas 3 8 8 9
Parallel Agents 0 0 4 8
AI/ML Features 0 0 4 6
Integration Points 2 8 15 20
Platform Support 1 2 3 4

Version History Document Version: {{PROJECT_VERSION}}
Last Updated: {{CURRENT_DATE}}
Migration Support: Contact support@apm-framework.dev for assistance

Clone this wiki locally