release-notes

リリースノート

範囲を特定する

1. リポジトリのリリース規約を確認し、バージョン、対象読者、正確な from_ref..to_ref の範囲を特定します。
2. 明確に判断できる場合は、到達可能なタグから前回のリリースを特定します。複数のリリース系列がある場合や、対象が不明で範囲に大きな曖昧さが生じる場合は、作業を進める前に確認します。
3. 両方の参照を検証し、SHA を記録します。正確な範囲を利用できる場合は、日付の範囲を使用しないでください。

根拠を集める

1. first-parent 履歴を使ってリリース規模の変更を特定し、その後、コミットの全一覧と差分を調べて、スカッシュ、リベース、直接のコミットを見落とさないようにします。
2. 関連する PR や Issue のメタデータにはリポジトリコネクターを優先して使用し、利用できない場合はホスティング CLI またはローカル Git を代替として使用します。
3. 設定、API、スキーマ、移行、依存関係、ランタイム、デプロイ、セキュリティに関する変更は、関連する差分を確認します。タイトルだけから影響を推測しないでください。
4. ユーザーに見える変更と内部メンテナンスを区別し、対象読者にとって役立たないノイズは省きます。

作成して検証する

• 何が変わったのか、そしてなぜ重要なのかを冒頭で説明します。
• 破壊的変更、前提条件、データや設定の移行、非推奨化、セキュリティ修正、既知の問題、ロールバックの制約を明記します。
• 利用可能な場合は、安定した PR または Issue の参照を含めます。
• 空のセクションは省略します。検証結果、Issue リンク、互換性に関する主張、リリース日を捏造しないでください。
• 提出前に、範囲、差分統計、移行やアップグレードの手順を再確認します。

references/release-notes-template.md は選択肢として使用し、すべての見出しを含める必要はありません。タグの公開やホストされたリリースの公開には、別途、明示的な承認が必要です。