プルリクエストから、内部向けの情報を除いたリリースノートを作成する
Beeuniに接続済みのGitHubリポジトリを読み込ませ、リリース対象の範囲を確認し、変更内容への参照を添えたユーザー向けのリリースノート案を作成します。
「エクスポートジョブをリファクタリング」というタイトルのプルリクエストは、レビュアーには確認箇所を伝えられます。しかし、顧客にとってはほとんど情報になりません。リリースノートでは、製品の何が変わったのか、誰に影響するのか、このリリースで利用できるのかを説明する必要があります。
リリースに含まれる内容を確認する
設定済みのGitHub接続を使って、エージェントにリポジトリへのアクセス権を付与します。直前と現在のタグを見つけてコミットを比較し、関連するプルリクエストを確認するよう依頼します。複数のリリースが進行中の場合は、リポジトリとタグを指定してください。
Read the connected repository and compare v1.4.0 with v1.5.0.
Draft release notes for users, grouped into features and fixes.
Inspect the linked PRs and diffs rather than relying on titles alone.
Keep a separate list of internal changes, reversions, and uncertain availability.
Save the draft with PR references. Do not publish a release.マージ済みのPRが必ずデプロイ済みとは限りません。また、同じ週にマージされた変更が、後のリリースに含まれることもあります。タグを比較すれば、どのコードが含まれているか確認できます。ただし、機能フラグや展開状況については、チームへの確認が必要な場合があります。
エージェントに、作業用の非公開リストを作成させます。リストには、参照元のPR、変更された動作、影響を受けるユーザー、リリースに含まれるかどうかを記載します。取り消された変更や、まだ無効になっている機能も確認してください。誰かが確認するまで、不確かな項目は公開用の草案に含めないでください。
実装の詳細をユーザー向けの変更内容に書き換える
次の例は、PRのメモを編集する際によくある判断を示しています。
| 作業メモ | リリースノート案 | 編集上の判断 |
|---|---|---|
| 選択したフィルターをクエリパラメーターに保存 | フィルターを適用した画面を共有すると、フィルターの設定もリンクに保持されるようになりました。 | 目に見える動作を説明する |
| ダブルクリックによる送信の重複を修正 | ［送信］を2回クリックすると、リクエストが重複して作成される問題を修正しました。 | きっかけと影響を明記する |
| テスト用ヘルパーを再編成 | 公開用リリースノートには記載しない | 保守作業の内容は内部記録に残す |
| 無効な機能フラグの背後にエクスポート機能を追加 | エクスポート機能が利用可能になるまで保留する | 告知前に利用可能か確認する |
読者が知りたい内容ごとに分類する
必要に応じて、新機能、改善、修正などのセクションを設けます。該当する項目がなければ、見出しは省きます。1つの機能に関する複数のPRは、1つの項目にまとめます。異なる操作に影響する修正は、別々に記載します。
必要な操作を、一般的な改善項目の中に埋もれさせないでください。APIのフィールドが変わる場合は、変更前と変更後の形式を明記し、移行手順へのリンクを付けます。特定のアカウントやクライアントだけで動作が変わる場合は、誰が対象なのかを示します。こうした詳細は、機能の担当者に確認してください。
草案を根拠情報と結び付けておく
- 公開用のリリースノートから削除する場合でも、レビュー用の原稿にはPRやコミットへの参照を残してください。
- 告知する機能が、説明対象のリリースで利用可能かどうかを確認してください。
- 内部ホスト名、認証情報、顧客情報、未公開の課題に関する内容を削除してください。
- 根拠となる測定値を示せない場合は、「高速化」などの表現を、具体的な動作の説明に置き換えてください。
公開用の草案と、項目を「含める」「除外する」「未解決」に分類した作業用リストの2つを作成するよう依頼します。レビュー後、接続で書き込みが許可されていれば、エージェントにリポジトリ内の草案を更新させることもできます。リリースの公開は、別途指示してください。フォームのバグを修正したと記載する場合は、主張を確認する際に使える再現記録について、ウェブサイトのテストガイドを参照してください。