Back to Details

docs-changelog

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Procedure: Updating Changelog for New Releases

流程：为新版本更新更新日志

The following instructions are run by Gemini CLI when processing new releases.
以下说明由Gemini CLI在处理新版本时执行。

Objective

目标

To standardize the process of updating the Gemini CLI changelog files for a new release, ensuring accuracy, consistency, and adherence to project style guidelines.
标准化为新版本更新Gemini CLI更新日志文件的流程，确保准确性、一致性，并符合项目风格指南。

Release Types

发布类型

This skill covers two types of releases:
  • Standard Releases: Regular, versioned releases that are announced to all users. These updates modify 
    docs/changelogs/latest.md
    and 
    docs/changelogs/index.md
    .
  • Preview Releases: Pre-release versions for testing and feedback. These updates only modify 
    docs/changelogs/preview.md
    .
Ignore all other releases, such as nightly releases.
本技能涵盖两种发布类型：
  • 标准发布： 面向所有用户公布的常规版本化发布。这些更新会修改
    docs/changelogs/latest.md
    和
    docs/changelogs/index.md
    。
  • 预览发布： 用于测试和收集反馈的预发布版本。这些更新仅修改
    docs/changelogs/preview.md
    。
忽略所有其他发布类型，例如夜间构建发布。

Expected Inputs

预期输入

Regardless of the type of release, the following information is expected:
  • New version number: The version number for the new release (e.g., 
    v0.27.0
    ).
  • Release date: The date of the new release (e.g., 
    2026-02-03
    ).
  • Raw changelog data: A list of all pull requests and changes included in the release, in the format 
    description by @author in #pr_number
    .
  • Previous version number: The version number of the last release can be calculated by decreasing the minor version number by one and setting the patch or bug fix version number.
无论发布类型如何，都需要以下信息：
  • 新版本号： 新版本的版本号（例如：
    v0.27.0
    ）。
  • 发布日期： 新版本的发布日期（例如：
    2026-02-03
    ）。
  • 原始更新日志数据： 包含在发布中的所有拉取请求和变更的列表，格式为
    description by @author in #pr_number
    。
  • 上一版本号： 上一个发布的版本号可通过将次要版本号减1，并设置补丁或 bug 修复版本号来计算。

Procedure

流程

Initial Setup

初始设置

  1. Identify the files to be modified:
    For standard releases, update 
    docs/changelogs/latest.md
    and 
    docs/changelogs/index.md
    . For preview releases, update 
    docs/changelogs/preview.md
    .
  2. Activate the 
    docs-writer
    skill.
  1. 确定需要修改的文件：
    对于标准发布，更新
    docs/changelogs/latest.md
    和
    docs/changelogs/index.md
    。对于预览发布，更新
    docs/changelogs/preview.md
    。
  2. 激活
    docs-writer
    技能。

Analyze Raw Changelog Data

分析原始更新日志数据

  1. Review the complete list of changes. If it is a patch or a bug fix with few changes, skip to the "Update 
    docs/changelogs/latest.md
    or 
    docs/changelogs/preview.md
    " section.
  2. Group related changes into high-level categories such as important features, "UI/UX Improvements", and "Bug Fixes". Use the existing announcements in 
    docs/changelogs/index.md
    as an example.
  1. 查看完整的变更列表。如果是补丁或包含少量变更的bug修复发布，直接跳至“更新
    docs/changelogs/latest.md
    或
    docs/changelogs/preview.md
    ”部分。
  2. 将相关变更分组为高级类别，例如重要功能、“UI/UX改进”和“Bug修复”。可参考
    docs/changelogs/index.md
    中已有的公告作为示例。

Create Highlight Summaries

创建要点摘要

Create two distinct versions of the release highlights.
Important: Carefully inspect highlights for "experimental" or "preview" features before public announcement, and do not include them.
创建两个不同版本的发布要点。
重要提示： 在公开公告前，仔细检查要点中的“实验性”或“预览”功能，不要包含这些内容。

Version 1: Comprehensive Highlights (for 
latest.md
or 
preview.md
)

版本1：详细要点（用于
latest.md
或
preview.md
）

Write a detailed summary for each category focusing on user-facing impact.
为每个类别撰写详细摘要，重点关注对用户的影响。

Version 2: Concise Highlights (for 
index.md
)

版本2：简洁要点（用于
index.md
）

Skip this step for preview releases.
Write concise summaries including the primary PR and author (e.g., 
([#12345](link) by @author)
).
预览发布可跳过此步骤。
撰写简洁摘要，包含主要PR和作者（例如：
([#12345](link) by @author)
）。

Update 
docs/changelogs/latest.md
or 
docs/changelogs/preview.md

更新
docs/changelogs/latest.md
或
docs/changelogs/preview.md

  1. Read current content and use 
    write_file
    to replace it with the new version number, and date.
If it is a patch or bug fix with few changes, simply add these changes to the "What's Changed" list. Otherwise, replace comprehensive highlights, and the full "What's Changed" list.
  1. For each item in the "What's Changed" list, keep usernames in plaintext, and add github links for each issue number. Example:
"- feat: implement /rewind command by @username in #12345"
  1. Skip entries by @gemini-cli-robot.
  2. Do not add the "New Contributors" section.
  3. Update the "Full changelog:" link with the previous version and the new version, unless it is a patch or a bug fix, in which case simply update the link's new version and keep the previous version the same.
  4. Ensure lines are wrapped to 80 characters.
  1. 读取当前内容，使用
    write_file
    替换为新版本号和日期。
    如果是补丁或包含少量变更的bug修复发布，只需将这些变更添加到“变更内容”列表中。否则，替换为详细要点和完整的“变更内容”列表。
  2. 对于“变更内容”列表中的每个条目，用户名保持纯文本格式，为每个问题号添加GitHub链接。示例：
"- feat: implement /rewind command by @username in #12345"
  1. 跳过@gemini-cli-robot的条目。
  2. 不要添加“新贡献者”部分。
  3. 更新“完整更新日志：”链接，包含上一版本和新版本，除非是补丁或bug修复发布，这种情况下只需更新链接中的新版本，保持上一版本不变。
  4. 确保每行换行不超过80个字符。

Update 
docs/changelogs/index.md

更新
docs/changelogs/index.md

Skip this step for patches, bug fixes, or preview releases.
Insert a new "Announcements" section for the new version directly above the previous version's section. Ensure lines are wrapped to 80 characters.
补丁、bug修复或预览发布可跳过此步骤。
在之前版本的公告部分上方插入新版本的“公告”部分。确保每行换行不超过80个字符。

Finalize

最终确认

Run 
npm run format
to ensure consistency.
运行
npm run format
以确保格式一致性。