ce-deprecation

Name: ce-deprecation
Availability: InStock
Author: moffran

Automate ADR-011 deprecation and removal workflows with warnings and migration notes.

78|15|Updated May 1, 2023

Search Tags:#documentation #deprecation #release-management #backward-compatibility #migration-guide #ADR-011

Ready to run

npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-deprecation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ce-deprecation
Source: https://github.com/Moffran/calibrated_explanations/tree/main/.claude/skills/ce-deprecation
Command: npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-deprecation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Organizations struggle to consistently deprecate and remove public API surfaces without breaking downstream users. This Skill provides a structured workflow aligned with ADR-011 to emit warnings, track migrations, and coordinate release timelines.

Core Features & Use Cases

Enforces ADR-011 deprecation policy across symbols, parameters, and module paths.
Maintains migration notes and updates the central deprecations docs to reflect active and removed items.
Coordinates removal timing using the two-minor-release rule to minimize disruption.

Quick Start

Follow ADR-011 to add a new deprecation entry and update the migration guide accordingly.

Frequently Asked Questions about ce-deprecation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I safely remove deprecated public API symbols without breaking downstream users?▼

To safely remove deprecated public API symbols, you must enforce the two-minor-release rule, emit deprecation warnings, and update migration notes before the actual removal to ensure backward compatibility.

What is the two-minor-release rule for API deprecation?▼

The two-minor-release rule for API deprecation requires that a public symbol, parameter, or module path remains in the codebase with active warnings for two minor release cycles before it can be fully removed.

How do I document a module path deprecation and track its migration timeline?▼

Document a module path deprecation by updating the migration guide and adding an entry to the Active Deprecations table in your central deprecations documentation to ensure full traceability and governance.

Does ADR-011 apply to deprecating serialized outputs and parameters?▼

Yes, ADR-011 applies to deprecating serialized outputs and parameters, enforcing consistent workflows for emitting warnings, adding migration notes, and coordinating release timelines across the codebase.

When should I not use an automated deprecation workflow for release management?▼

You should not use an automated deprecation workflow when immediate removal is required without a migration period, as ADR-011 strictly enforces the two-minor-release rule to prevent breaking downstream dependencies.