instantly-upgrade-migration

Analyze, plan, and execute Instantly SDK upgrades with breaking change detection.Use when upgrading Instantly SDK versions, detecting deprecations,or migrating to new API versions.Trigger with phrases like "upgrade instantly", "instantly migration","instantly breaking changes", "update instantly SDK", "analyze instantly version".

⭐920stars🔀111forks📁View on GitHub🕐Updated Jan 9, 2026

When & Why to Use This Skill

This Claude skill automates the end-to-end process of upgrading and migrating the Instantly SDK. It streamlines developer workflows by identifying breaking changes, managing npm dependencies, and refactoring code to align with the latest API versions. By integrating version control and automated testing, it ensures a safe and efficient transition between SDK releases while minimizing manual debugging time.

Use Cases

  • Major Version Migration: Automatically refactor legacy code when upgrading from Instantly SDK v1.x to v2.x, such as updating import statements from 'Client' to 'InstantlyClient'.
  • Breaking Change Detection: Scan and update configuration objects to match new API requirements, ensuring that parameters like 'apiKey' are correctly implemented after a version update.
  • Automated Workflow Execution: Use bash tools to check current SDK versions, create dedicated git branches for upgrades, and run test suites to verify system stability post-migration.
  • Proactive Deprecation Handling: Implement monitoring scripts to catch and log deprecation warnings in development environments, allowing teams to address potential issues before they impact production.
nameinstantly-upgrade-migration
description|
allowed-toolsRead, Write, Edit, Bash(npm:*), Bash(git:*)
version1.0.0
licenseMIT
authorJeremy Longshore <jeremy@intentsolutions.io>

Instantly Upgrade & Migration

Overview

Guide for upgrading Instantly SDK versions and handling breaking changes.

Prerequisites

  • Current Instantly SDK installed
  • Git for version control
  • Test suite available
  • Staging environment

Instructions

Step 1: Check Current Version

npm list @instantly/sdk
npm view @instantly/sdk version

Step 2: Review Changelog

open https://github.com/instantly/sdk/releases

Step 3: Create Upgrade Branch

git checkout -b upgrade/instantly-sdk-vX.Y.Z
npm install @instantly/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 '@instantly/sdk';

// After (v2.x)
import { InstantlyClient } from '@instantly/sdk';

Configuration Changes

// Before (v1.x)
const client = new Client({ key: 'xxx' });

// After (v2.x)
const client = new InstantlyClient({
  apiKey: 'xxx',
});

Rollback Procedure

npm install @instantly/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('[Instantly]', 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 instantly-ci-integration.