windsurf-upgrade-migration
Analyze, plan, and execute Windsurf SDK upgrades with breaking change detection.Use when upgrading Windsurf SDK versions, detecting deprecations,or migrating to new API versions.Trigger with phrases like "upgrade windsurf", "windsurf migration","windsurf breaking changes", "update windsurf SDK", "analyze windsurf version".
When & Why to Use This Skill
The Windsurf Upgrade & Migration skill is a specialized utility designed to automate the complex process of updating Windsurf SDK versions. It streamlines the developer workflow by proactively detecting breaking changes, identifying deprecated APIs, and executing code refactors. By integrating version analysis with Git-based workflows and automated testing, it ensures a safe, efficient, and well-documented migration path for any project utilizing the Windsurf ecosystem.
Use Cases
- Major Version Migration: Automatically refactor deprecated import statements and configuration objects when upgrading from Windsurf SDK v1.x to v2.x.
- Breaking Change Detection: Scan codebases to identify API method signatures that have changed in the latest release and apply necessary updates to ensure compatibility.
- Automated Upgrade Planning: Generate a comprehensive upgrade plan that includes version checks, changelog reviews, and the creation of dedicated migration branches.
- Risk Management & Rollback: Execute safe updates with built-in test suite verification and documented rollback procedures to minimize downtime during dependency updates.
- Proactive Deprecation Monitoring: Set up development environment listeners to catch and log deprecation warnings before they become breaking issues in production.
| name | windsurf-upgrade-migration |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit, Bash(npm:*), Bash(git:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Windsurf Upgrade & Migration
Overview
Guide for upgrading Windsurf SDK versions and handling breaking changes.
Prerequisites
- Current Windsurf SDK installed
- Git for version control
- Test suite available
- Staging environment
Instructions
Step 1: Check Current Version
npm list @windsurf/sdk
npm view @windsurf/sdk version
Step 2: Review Changelog
open https://github.com/windsurf/sdk/releases
Step 3: Create Upgrade Branch
git checkout -b upgrade/windsurf-sdk-vX.Y.Z
npm install @windsurf/sdk@latest
npm test
Step 4: Handle Breaking Changes
Update import statements, configuration, and method signatures as needed.
Output
- Updated SDK version
- Fixed breaking changes
- Passing test suite
- Documented rollback procedure
Error Handling
| SDK Version | API Version | Node.js | Breaking Changes |
|---|---|---|---|
| 3.x | 2024-01 | 18+ | Major refactor |
| 2.x | 2023-06 | 16+ | Auth changes |
| 1.x | 2022-01 | 14+ | Initial release |
Examples
Import Changes
// Before (v1.x)
import { Client } from '@windsurf/sdk';
// After (v2.x)
import { WindsurfClient } from '@windsurf/sdk';
Configuration Changes
// Before (v1.x)
const client = new Client({ key: 'xxx' });
// After (v2.x)
const client = new WindsurfClient({
apiKey: 'xxx',
});
Rollback Procedure
npm install @windsurf/sdk@1.x.x --save-exact
Deprecation Handling
// Monitor for deprecation warnings in development
if (process.env.NODE_ENV === 'development') {
process.on('warning', (warning) => {
if (warning.name === 'DeprecationWarning') {
console.warn('[Windsurf]', warning.message);
// Log to tracking system for proactive updates
}
});
}
// Common deprecation patterns to watch for:
// - Renamed methods: client.oldMethod() -> client.newMethod()
// - Changed parameters: { key: 'x' } -> { apiKey: 'x' }
// - Removed features: Check release notes before upgrading
Resources
Next Steps
For CI integration during upgrades, see windsurf-ci-integration.