| name | clay-upgrade-migration |
| description | 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".
|
| 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
import { Client } from '@clay/sdk';
import { ClayClient } from '@clay/sdk';
Configuration Changes
const client = new Client({ key: 'xxx' });
const client = new ClayClient({
apiKey: 'xxx',
});
Rollback Procedure
npm install @clay/sdk@1.x.x --save-exact
Deprecation Handling
if (process.env.NODE_ENV === 'development') {
process.on('warning', (warning) => {
if (warning.name === 'DeprecationWarning') {
console.warn('[Clay]', warning.message);
}
});
}
Resources
Next Steps
For CI integration during upgrades, see clay-ci-integration.
