firecrawl-upgrade-migration
Analyze, plan, and execute FireCrawl SDK upgrades with breaking change detection.Use when upgrading FireCrawl SDK versions, detecting deprecations,or migrating to new API versions.Trigger with phrases like "upgrade firecrawl", "firecrawl migration","firecrawl breaking changes", "update firecrawl SDK", "analyze firecrawl version".
When & Why to Use This Skill
This Claude skill provides a specialized automation framework for managing FireCrawl SDK upgrades and migrations. It streamlines the developer workflow by proactively detecting breaking changes, identifying deprecated methods, and automating the refactoring of API configurations. By handling version analysis, branch management, and test verification, it ensures that web crawling and scraping integrations remain stable and up-to-date with the latest FireCrawl features.
Use Cases
- Major Version Migration: Automatically refactor codebases when transitioning between major SDK versions, such as updating import statements and class constructors (e.g., migrating from 'Client' to 'FireCrawlClient').
- Breaking Change Detection: Scan existing projects to identify deprecated parameters or method signatures before they cause runtime failures during an API version update.
- Automated Upgrade Lifecycle: Execute a complete upgrade workflow including checking current versions, creating dedicated git branches, installing the latest packages, and verifying the update with existing test suites.
- Deprecation Monitoring: Implement proactive warning systems in development environments to catch and log deprecation notices, allowing for planned maintenance instead of reactive fixes.
| name | firecrawl-upgrade-migration |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit, Bash(npm:*), Bash(git:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
FireCrawl Upgrade & Migration
Overview
Guide for upgrading FireCrawl SDK versions and handling breaking changes.
Prerequisites
- Current FireCrawl SDK installed
- Git for version control
- Test suite available
- Staging environment
Instructions
Step 1: Check Current Version
npm list @firecrawl/sdk
npm view @firecrawl/sdk version
Step 2: Review Changelog
open https://github.com/firecrawl/sdk/releases
Step 3: Create Upgrade Branch
git checkout -b upgrade/firecrawl-sdk-vX.Y.Z
npm install @firecrawl/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 '@firecrawl/sdk';
// After (v2.x)
import { FireCrawlClient } from '@firecrawl/sdk';
Configuration Changes
// Before (v1.x)
const client = new Client({ key: 'xxx' });
// After (v2.x)
const client = new FireCrawlClient({
apiKey: 'xxx',
});
Rollback Procedure
npm install @firecrawl/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('[FireCrawl]', 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 firecrawl-ci-integration.