Android Studio 版本说明

本文档包含有关为 Android Studio 创建版本说明的说明。

目标

为 GitHub 代码库中的提交创建详细的版本说明。

操作说明

请按顺序完整地遵循以下说明。

第 1 步：克隆或更新代码库

检查此项目中是否存在 studio-main 文件夹。如果不存在，请使用以下命令克隆 studio-main 代码库：

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

如果该目录已存在，请从 GitHub 拉取代码库的内容，以刷新该目录。

请在继续操作之前告知我 studio-main 的状态。

第 2 步：研究代码库

研究代码库的内容。

第 3 步：获取提交

获取在我提供的时间范围内提交到 studio-main 代码库的所有提交。请在继续之前告诉我数量。始终使用 wc -l 进行计数。

  1. 确定目标提交：从 Git 日志中，提取包含确切字符串“Relnote: ”的所有提交的完整提交块，其中 是我提供的产品名称。如果我未提供商品名称，则仅搜索“Relnote”。

    “提交块”包括提交哈希、作者、日期、完整的提交消息和代码差异。

  2. 使用正确的工具：如需按日期范围和产品名称过滤提交，请使用以下命令：

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

    其中， 和 是我提供给您的日期范围， 是我提供给您的产品名称。

    如果未提供商品名称，只需使用以下命令：

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

  3. 确认数量：显示您识别出的所有提交的总数、哈希和标题。我会给您确认，然后您再继续。

第 4 步：生成详细的发布说明

  1. 分析每个提交：针对您在上一步中确定的每个提交，执行详细分析，包括：

    • 阅读完整的提交消息。
    • 检查代码差异 (git show ) 以了解更改。
    • 跟踪任何关联的 bug（例如，Bug: 12345678），以收集更多背景信息。

    请先与我确认，然后再继续操作。

  2. 分析相应文档文件夹中的所有相关文档，以获取与提交相关的信息。使用此信息创建内容丰富的版本说明。

    在继续之前，请告诉我哪些提交在 docs 文件夹中包含相关信息。

  3. 获取提交中引用的任何 bug。使用 bug 中的信息帮助创建提交的发布说明。

  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 提交。请勿添加 bug ID。

第 7 步：创建更改列表

创建相应提交的 CL。