Deprecation Consolidation
Ensure deprecations and migration notices are not duplicated across the newsletter and are presented once in the right place.
Quick Start
- •Read the assembled newsletter file at
output/YYYY-MM_month_newsletter.md. - •Find all deprecation/migration/sunset content anywhere in the document.
- •Move it into a single bundled bullet under Enterprise and Security Updates.
- •Delete any standalone
# Migration Noticessection. - •Re-run validation:
bash .github/skills/newsletter-validation/scripts/validate_newsletter.sh output/YYYY-MM_month_newsletter.md.
Core Rules (Hard Requirements)
Rule 1: Single bundled update
All of these belong in one bullet (one paragraph) under Enterprise and Security Updates:
- •Deprecations (models/features/SDKs)
- •Sunsets / API shutdowns
- •Token revocations
- •Minimum version enforcement
- •Syntax changes that can break workflows (e.g., comment commands)
Use a title like:
- •
**Deprecations and Migration Notices** -- ...
Rule 2: No bottom-of-newsletter migration section
Do not end the newsletter with a standalone section like:
- •
# Migration Notices
If it exists, it must be removed and its content merged into the Enterprise & Security bullet.
Rule 3: Remove duplicate mentions elsewhere
If deprecation content appears in other bullets (common places: model availability bullets, metrics bullets), do one of:
- •Remove the deprecation sentence/link entirely, OR
- •Replace it with a short pointer: "See Deprecations and Migration Notices in Enterprise and Security Updates."
Prefer removal over pointers unless the section would otherwise become misleading.
Editing Workflow
- •Inventory: Identify every deprecation/migration statement and every link that implies deprecation (e.g.,
upcoming-deprecation,closing-down-notice,revoked,minimum-version-enforcement). - •Choose canonical placement: Under Enterprise and Security Updates, immediately after the most related bullet (often metrics/governance).
- •Bundle: Write one bullet that lists the items as bolded phrases in a single sentence/paragraph.
- •Linking: Include the authoritative links (usually changelog entries) as pipe-separated links at the end.
- •Delete old section: Remove
# Migration Noticesheading and its bullet(s). - •Re-scan for dupes: Ensure the same deprecation link doesn’t appear in multiple sections.
Optional Helper
Run the helper script to surface candidates:
bash
python3 .github/skills/deprecation-consolidation/scripts/find_deprecations.py output/YYYY-MM_month_newsletter.md
Done When
- • Newsletter contains no
# Migration Noticessection - • Exactly one bundled deprecations/migration bullet exists under Enterprise & Security
- • Deprecation/sunset links are not duplicated in other sections
- •
validate_newsletter.shexits 0