Android Studio リリースノート

このドキュメントでは、Android Studio のリリースノートを作成する手順について説明します。

目標

GitHub リポジトリのコミットの詳細なリリースノートを作成します。

手順

以下の手順に沿って、順番に操作してください。

ステップ 1: リポジトリのクローンを作成または更新する

このプロジェクトに studio-main フォルダがあるかどうかを確認します。存在しない場合は、次のコマンドを使用して studio-main リポジトリのクローンを作成します。

git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main

ディレクトリがすでに存在する場合は、GitHub からリポジトリのコンテンツを pull してディレクトリを更新します。

続行する前に、studio-main のステータスを教えてください。

ステップ 2: リポジトリを調べる

リポジトリの内容を確認します。

ステップ 3: コミットを取得する

指定した期間に studio-main リポジトリに送信されたすべての commit を取得します。続行する前にカウントをお知らせください。カウントには常に wc -l を使用します。

  1. ターゲット コミットを特定する: git ログから、私が提供したプロダクト名 を含む文字列「Relnote: 」を正確に含むすべてのコミットの完全なコミット ブロックを抽出します。商品名を指定しない場合は、「Relnote」で検索してください。

    「コミット ブロック」には、コミット ハッシュ、作成者、日付、完全なコミット メッセージ、コード差分が含まれます。

  2. 適切なツールを使用する: コミットを日付範囲とプロダクト名でフィルタするには、次のコマンドを使用します。

    git log --after="" --before="" --grep="Relnote: "

    ここで、 と は指定した期間、 は指定したプロダクト名です。

    プロダクト名が指定されていない場合は、次のコマンドを使用します。

    git log --after="" --before="" --grep="Relnote"

  3. カウントを確認する: 識別したすべてのコミットの合計数、ハッシュ、タイトルを表示します。手続きを進めることを確認します。

ステップ 4: 詳細なリリースノートを生成する

  1. 各コミットを分析する: 前のステップで特定したコミットごとに、詳細な分析を行います。これには次のものが含まれます。

    • コミット メッセージ全体を読み取ります。
    • コードの差分（git show ）を調べて変更内容を理解する。
    • リンクされたバグ（例: バグ: 12345678）をたどって、コンテキストを収集します。

    続行する前に、私に確認してください。

  2. docs フォルダ内の関連ドキュメントを分析して、コミットに関連する情報を取得します。この情報を使用して、コンテンツが豊富なリリースノートを作成します。

    続行する前に、どのコミットに docs フォルダ内の関連情報が含まれているか教えてください。

  3. コミットで参照されているバグを取得します。バグの情報を使用して、コミットのリリースノートを作成します。

  4. リリースノートを作成する: 各コミットについて、次の内容を含むリリースノートを作成します。

    • コミット参照: 各リリースノートの前に、次のようにソースコミット ハッシュを含む Markdown コメントを付けます。

    • 明確なタイトル: 変更内容を簡潔にまとめた文頭大文字の文。

    • 詳細な説明: 変更内容を説明する段落。

    • 変更に関する重要なポイントを次の順序で説明します。

      a. 理由: 変更内容とその理由 b. 影響: アプリ デベロッパーへの影響 c. 移行: 移行パス（ある場合）

    • 変更前後のコード例: コミットにユーザー向けのコード変更（.gradle ファイルの DSL 変更や API の変更など）が含まれる場合は、変更を示す明確で簡潔なコード スニペットを提供します。

    https://developer.android.com/studio/releases のリリースノートのスタイルに沿ってください。

ステップ 5: リリースノートを Markdown ファイルに書き込む

  1. プロジェクトのルートに release-notes-YYYY-MM-DDTHH:MM.md という名前の Markdown ファイルを作成します。ここで、YYYY-MM-DD（年-月-日）は ISO 8601 形式の現在の日付、T は区切り文字、HH:MM（24 時間形式の時:分）は現在の時刻です。
  2. リリースノートの目的を説明する導入文を書きます。
  3. リリースノートの概要を記述します。
  4. 完全な書式設定済みのリリースノートを記述します。

ステップ 6: コミットを作成する

リリースノート ファイルの Fig コミットを作成します。バグ ID は含めないでください。

ステップ 7: 変更リストを作成する

commit の CL を作成します。