非推奨通知を含むフィーチャーリリース

古いAPIを非推奨にしながら新機能を追加するマイナーバージョンのリリースノートの書き方。非推奨タイムライン、移行ヒント、廃止日を解説します。

Minor Releases

詳細な説明

非推奨を含むフィーチャーリリース

マイナーリリース(例:v1.3.0)は後方互換性を維持しながら新機能を追加します。マイナーリリースが既存の機能を非推奨にする場合、リリースノートではエキサイティングな新機能と非推奨タイムラインの両方を明確に伝える必要があります。

非推奨通知のベストプラクティス

非推奨にする各項目には以下を含めるべきです:

  1. 何が非推奨か(関数名、設定オプション、動作)
  2. 代替 — 代わりに何を使うべきか
  3. タイムライン — いつ削除されるか(具体的なバージョン)
  4. 移行パス — ガイドへのリンクまたはインライン手順
  5. ランタイム警告 — コードが非推奨警告を出力することを確認

非推奨タイムライン

v1.3.0 — 警告付きで非推奨化(現在)
v1.4.0 — strictモードで警告がエラーに
v2.0.0 — 完全に削除

これによりユーザーに2つのマイナーリリースの移行期間が与えられ、一般的で妥当なタイムラインです。

ユースケース

古いパターンの代替として新しいAPIを導入するライブラリのマイナーバージョンをリリースし、次のメジャーバージョンで非推奨機能が削除される前にユーザーに移行時間を与える場合。

試してみる — Release Notes Generator

フルツールを開く