clay-upgrade-migration
Analyze, plan, and execute Clay SDK upgrades with breaking change detection.Use when upgrading Clay SDK versions, detecting deprecations,or migrating to new API versions.Trigger with phrases like "upgrade clay", "clay migration","clay breaking changes", "update clay SDK", "analyze clay version".
When & Why to Use This Skill
This Claude skill streamlines the Clay SDK upgrade and migration process by identifying breaking changes, managing version transitions, and providing actionable guidance for code updates. It helps developers minimize technical debt and ensure compatibility with the latest Clay API features through automated analysis, structured workflows, and proactive deprecation detection.
Use Cases
- Upgrading Clay SDK versions while automatically detecting and fixing breaking changes in import statements and method signatures.
- Migrating legacy Clay configurations to new API standards with step-by-step instructions and validated code examples.
- Generating safe upgrade branches and documented rollback procedures to maintain system stability during dependency updates.
- Proactively identifying and resolving deprecation warnings in development environments before they impact production performance.
| name | clay-upgrade-migration |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit, Bash(npm:*), Bash(git:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Clay Upgrade & Migration
Overview
Guide for upgrading Clay SDK versions and handling breaking changes.
Prerequisites
- Current Clay SDK installed
- Git for version control
- Test suite available
- Staging environment
Instructions
Step 1: Check Current Version
npm list @clay/sdk
npm view @clay/sdk version
Step 2: Review Changelog
open https://github.com/clay/sdk/releases
Step 3: Create Upgrade Branch
git checkout -b upgrade/clay-sdk-vX.Y.Z
npm install @clay/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 '@clay/sdk';
// After (v2.x)
import { ClayClient } from '@clay/sdk';
Configuration Changes
// Before (v1.x)
const client = new Client({ key: 'xxx' });
// After (v2.x)
const client = new ClayClient({
apiKey: 'xxx',
});
Rollback Procedure
npm install @clay/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('[Clay]', 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 clay-ci-integration.