ideogram-upgrade-migration

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

⭐939stars🔀114forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

The Ideogram Upgrade & Migration skill is designed to automate and streamline the process of updating Ideogram SDK versions. It intelligently detects breaking changes, identifies deprecated methods, and executes code migrations, ensuring your application remains compatible with the latest API features while significantly reducing manual refactoring effort and technical debt.

Use Cases

  • Case 1: Upgrading from legacy Ideogram SDK versions (e.g., v1.x to v2.x) by automatically refactoring import statements and updating client configuration patterns.
  • Case 2: Proactively identifying and resolving deprecation warnings in development environments to ensure long-term stability before new API versions become mandatory.
  • Case 3: Automating the end-to-end upgrade workflow, including creating dedicated git branches, performing npm updates, and running test suites to verify compatibility.
nameideogram-upgrade-migration
description|
allowed-toolsRead, Write, Edit, Bash(npm:*), Bash(git:*)
version1.0.0
licenseMIT
authorJeremy Longshore <jeremy@intentsolutions.io>

Ideogram Upgrade & Migration

Overview

Guide for upgrading Ideogram SDK versions and handling breaking changes.

Prerequisites

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

Instructions

Step 1: Check Current Version

npm list @ideogram/sdk
npm view @ideogram/sdk version

Step 2: Review Changelog

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

Step 3: Create Upgrade Branch

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

// After (v2.x)
import { IdeogramClient } from '@ideogram/sdk';

Configuration Changes

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

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

Rollback Procedure

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