OpenParable
Skip to content
← Back to skills

Deprecation Manager

Development
deprecation-manager

Deprecation Manager is an Agent Skill for development published in the a5c-ai/babysitter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Manage API and SDK deprecation lifecycle

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/a5c-ai/babysitter/blob/HEAD/library/specializations/sdk-platform-development/skills/deprecation-manager/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/deprecation-manager, 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.

Deprecation Manager Skill

Overview

This skill manages the complete deprecation lifecycle for APIs and SDKs, from initial deprecation notices through sunset, ensuring smooth transitions for API consumers.

Capabilities

  • Track deprecation timelines and milestones
  • Inject deprecation warnings in SDK code
  • Send sunset notifications to API consumers
  • Generate migration documentation automatically
  • Monitor deprecated endpoint usage
  • Configure Sunset and Deprecation HTTP headers
  • Implement gradual deprecation with usage thresholds
  • Archive deprecated documentation appropriately

Target Processes

  • Backward Compatibility Management
  • API Versioning Strategy
  • SDK Versioning and Release Management

Integration Points

  • Sunset header injection middleware
  • Deprecation annotation processors
  • Usage analytics systems
  • Email/notification services
  • Documentation platforms

Input Requirements

  • Deprecation policy and timelines
  • Affected endpoints/features list
  • Replacement/migration paths
  • Consumer notification requirements
  • Usage monitoring access

Output Artifacts

  • Deprecation timeline documentation
  • SDK deprecation annotations
  • Migration guides
  • Sunset header configurations
  • Consumer notification templates
  • Usage monitoring dashboards
  • Archived documentation

Usage Example

skill:
  name: deprecation-manager
  context:
    deprecationPolicy: ./docs/deprecation-policy.md
    features:
      - featureId: legacy-auth
        deprecationDate: "2024-06-01"
        sunsetDate: "2024-12-01"
        replacement: oauth2-flow
    notificationChannels:
      - email
      - dashboard
      - sdkWarnings
    usageThreshold: 100

Best Practices

  1. Announce deprecations well in advance (6+ months)
  2. Provide clear migration paths with examples
  3. Monitor usage before sunset
  4. Send multiple reminder notifications
  5. Keep deprecated docs available but marked
  6. Implement gradual rate limiting before full sunset