OpenParable
Skip to content
← Back to skills

Coderabbit Upgrade Migration

Development
coderabbit-upgrade-migration

Coderabbit Upgrade Migration is an Agent Skill for development published in the Dicklesworthstone/pi_agent_rust repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Dicklesworthstone/pi_agent_rust/blob/HEAD/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/coderabbit-pack/skills/coderabbit-upgrade-migration/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/coderabbit-upgrade-migration, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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

npm list @coderabbit/sdk
npm view @coderabbit/sdk version

Step 2: Review Changelog

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

Step 3: Create Upgrade Branch

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 VersionAPI VersionNode.jsBreaking Changes
3.x2024-0118+Major refactor
2.x2023-0616+Auth changes
1.x2022-0114+Initial release

Examples

Import Changes

// Before (v1.x)
import { Client } from '@coderabbit/sdk';

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

Configuration Changes

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

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

Rollback Procedure

npm install @coderabbit/[email protected] --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('[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

Next Steps

For CI integration during upgrades, see coderabbit-ci-integration.