Before You Upgrade
1. Review the Changelog
Always check the Changelog for breaking changes and new features between your current version and the target version.2. Check Your Current Version
3. Review Your Dependencies
4. Backup Your Code
Create a git branch or backup before upgrading:Upgrade Process
Standard Upgrade
Upgrade to Specific Version
Upgrade with Clean Install
Testing After Upgrade
1. Type Checking
If using TypeScript:2. Run Tests
3. Manual Testing
Test critical paths in your application:Common Migration Scenarios
Migrating to DedalusRunner
If you have custom tool execution logic, consider migrating toDedalusRunner:
Before:
After:
Migrating to MCP Server
If you expose Dedalus functionality to AI applications:Before:
After:
Migrating Model Specifications
The SDK now supports more flexible model specifications:Before:
After:
Migrating Response Format
New structured output support:Before:
After:
Migrating to Streaming
Improved streaming support:Before:
After (same, but more robust):
Breaking Changes by Version
Alpha 8
MCP Server Tool Names Some MCP tools have been renamed for consistency:- Tool names now use snake_case consistently
- Resource paths use dot notation (e.g.,
chat.completions)
DedalusModelandModeltypes are now separate- Model specifications are more strictly typed
Alpha 7
No breaking changes.Alpha 6
Messages Parameter Themessages parameter can now be null:
Alpha 5
MCP Server Configuration MCP server options have changed:Deprecation Warnings
returnIntent Parameter
ThereturnIntent parameter in DedalusRunner.run() is deprecated:
Environment Variables
New in Alpha 8
DEDALUS_LOG- Set log level (debug, info, warn, error, off)
Existing Variables
DEDALUS_API_KEY- Your API key (required)DEDALUS_ENVIRONMENT- Environment (production, development)DEDALUS_BASE_URL- Custom API base URL
Best Practices
1. Pin Versions in Production
2. Test in Staging First
Always test upgrades in a staging environment before production.3. Update All Related Packages
4. Review Type Changes
If using TypeScript, review all type errors after upgrading:5. Monitor Logs
Enable verbose logging during migration:6. Use Feature Flags
Gradually roll out new features:Rollback Strategy
If you encounter issues:1. Revert Package Version
2. Revert Git Changes
3. Clear Cache
Getting Help
If you run into issues:- Check the Changelog for known issues
- Review API documentation for updated signatures
- Search GitHub issues
- Open a new issue with:
- Current version
- Target version
- Error message
- Minimal reproduction code
Monitoring After Upgrade
1. Watch Error Rates
Monitor your error logs for new patterns:2. Track Performance
3. Verify Tool Execution
If using DedalusRunner:Version Support Policy
The Dedalus SDK is currently in alpha. Version support:- Latest alpha: Fully supported
- Previous alpha: Bug fixes only
- Older alphas: No support
Future Breaking Changes
Be aware of upcoming changes:Beta Release
- API stabilization
- Potential breaking changes to experimental features
- Migration guide will be provided
V1.0 Release
- Stable API
- Semantic versioning
- Clear deprecation policy
Feedback
Help us improve the SDK:- Report migration issues
- Suggest API improvements
- Share your use cases