playbooks

home / skills / jeremylongshore / claude-code-plugins-plus-skills / coderabbit-upgrade-migration

coderabbit-upgrade-migration skill

/plugins/saas-packs/coderabbit-pack/skills/coderabbit-upgrade-migration

This skill guides you through CodeRabbit SDK upgrades, detects breaking changes, and ensures a smooth migration with tests and rollback steps.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill coderabbit-upgrade-migration

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.8 KB
---
name: coderabbit-upgrade-migration
description: |
  Analyze, plan, and execute CodeRabbit SDK upgrades with breaking change detection.
  Use when upgrading CodeRabbit SDK versions, detecting deprecations,
  or migrating to new API versions.
  Trigger with phrases like "upgrade coderabbit", "coderabbit migration",
  "coderabbit breaking changes", "update coderabbit SDK", "analyze coderabbit version".
allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(git:*)
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---

# CodeRabbit Upgrade & Migration

## Overview
Guide for upgrading CodeRabbit SDK versions and handling breaking changes.

## Prerequisites
- Current CodeRabbit SDK installed
- Git for version control
- Test suite available
- Staging environment

## Instructions

### Step 1: Check Current Version
```bash
npm list @coderabbit/sdk
npm view @coderabbit/sdk version
```

### Step 2: Review Changelog
```bash
open https://github.com/coderabbit/sdk/releases
```

### Step 3: Create Upgrade Branch
```bash
git checkout -b upgrade/coderabbit-sdk-vX.Y.Z
npm install @coderabbit/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
```typescript
// Before (v1.x)
import { Client } from '@coderabbit/sdk';

// After (v2.x)
import { CodeRabbitClient } from '@coderabbit/sdk';
```

### Configuration Changes
```typescript
// Before (v1.x)
const client = new Client({ key: 'xxx' });

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

### Rollback Procedure
```bash
npm install @coderabbit/[email protected] --save-exact
```

### Deprecation Handling
```typescript
// Monitor for deprecation warnings in development
if (process.env.NODE_ENV === 'development') {
  process.on('warning', (warning) => {
    if (warning.name === 'DeprecationWarning') {
      console.warn('[CodeRabbit]', 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
- [CodeRabbit Changelog](https://github.com/coderabbit/sdk/releases)
- [CodeRabbit Migration Guide](https://docs.coderabbit.com/migration)

## Next Steps
For CI integration during upgrades, see `coderabbit-ci-integration`.

Overview

This skill analyzes, plans, and executes CodeRabbit SDK upgrades while detecting breaking changes and deprecations. It guides teams through version checks, changelog review, branch-based upgrades, and targeted code fixes to restore a green test suite. Use it to reduce upgrade risk and automate repeatable migration steps.

How this skill works

The skill inspects your current installed CodeRabbit SDK version, compares it against release notes and known breaking-change tables, and generates a migration plan. It can propose concrete code edits (imports, configuration keys, method signatures), run tests after installing the target SDK, and produce rollback instructions. It highlights deprecation warnings and maps common renames or parameter changes to actionable fixes.

When to use it

  • Preparing to upgrade @coderabbit/sdk to a newer major or minor version
  • Detecting and resolving breaking changes after a dependency bump
  • Migrating code to new API shapes (imports, constructors, method names)
  • Validating upgrades in CI or staging before production deploy
  • Creating a repeatable upgrade branch and rollback plan

Best practices

  • Always run in a feature branch (e.g., upgrade/coderabbit-sdk-vX.Y.Z) and push changes for CI validation
  • Review the official changelog and migration guide before applying changes locally
  • Run the full test suite and smoke tests in a staging environment after upgrade
  • Search and update imports, configuration keys, and renamed methods systematically
  • Log and track deprecation warnings during development for proactive fixes

Example use cases

  • Upgrade from 1.x -> 2.x where imports and config keys were renamed (Client -> CodeRabbitClient, key -> apiKey)
  • Handle an auth-related breaking change introduced in a 2.x release by updating credential handling and tests
  • Automate CI job that runs npm install @coderabbit/sdk@latest, runs tests, and reports breaking-change candidates
  • Create rollback steps by pinning to a previous exact SDK version and documenting the revert commands

FAQ

What should I check before upgrading?

Confirm current SDK version, run tests locally, read the changelog and migration guide, and ensure a staging environment is available.

How do I detect renamed methods or config keys?

Search the codebase for client usage patterns and compare against release notes; the skill suggests common mappings like client.oldMethod -> client.newMethod and { key } -> { apiKey }.

What is the rollback procedure?

Pin the previous version with an exact install (e.g., npm install @coderabbit/[email protected] --save-exact), revert the upgrade branch, and run tests to verify behavior.