gen-changelog

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

根据当前分支相对于 main 分支的修改，生成更新日志条目并同步到文档站点。

Generate changelog entries based on the changes of the current branch relative to the main branch, and sync them to the documentation site.

分析变更：查看

git log main..HEAD --oneline

和

git diff main..HEAD --stat

，理解所有变更。

更新源 CHANGELOG：在根目录
```
CHANGELOG.md
```
的
```
## Unreleased
```
下添加条目；如果变更属于
```
packages/
```
或
```
sdks/
```
下的子包，同时更新对应目录的
```
CHANGELOG.md
```
。

同步英文文档 changelog：运行

node docs/scripts/sync-changelog.mjs

将根

CHANGELOG.md

同步到

docs/en/release-notes/changelog.md

。

更新中文文档 changelog：在
```
docs/zh/release-notes/changelog.md
```
的
```
## 未发布
```
下添加对应的中文翻译条目，遵循现有格式和用词规范（参考
```
docs/AGENTS.md
```
中的术语表和排版规范）。
Breaking changes（如有）：如果变更包含破坏性变更（如移除/重命名选项、更改默认行为、迁移配置格式等），还需在
```
docs/en/release-notes/breaking-changes.md
```
和
```
docs/zh/release-notes/breaking-changes.md
```
的
```
## Unreleased
```
/
```
## 未发布
```
下添加对应条目，遵循现有的格式（版本标题 + 小节 + 受影响/迁移说明）。

Analyze Changes: Check

git log main..HEAD --oneline

and

git diff main..HEAD --stat

to understand all changes.

Update the Source CHANGELOG: Add entries under
```
## Unreleased
```
in the root directory's
```
CHANGELOG.md
```
; if the changes belong to sub-packages under
```
packages/
```
or
```
sdks/
```
, also update the
```
CHANGELOG.md
```
in the corresponding directory.

Sync English Documentation Changelog: Run

node docs/scripts/sync-changelog.mjs

to sync the root

CHANGELOG.md

docs/en/release-notes/changelog.md

Update Chinese Documentation Changelog: Add corresponding Chinese translated entries under
```
## Unreleased
```
in
```
docs/zh/release-notes/changelog.md
```
, following the existing format and terminology specifications (refer to the glossary and typesetting guidelines in
```
docs/AGENTS.md
```
).
Breaking Changes (if applicable): If the changes include breaking changes (such as removing/renaming options, changing default behaviors, migrating configuration formats, etc.), you also need to add corresponding entries under
```
## Unreleased
```
in
```
docs/en/release-notes/breaking-changes.md
```
and
```
docs/zh/release-notes/breaking-changes.md
```
, following the existing format (version title + section + affected/migration instructions).

Follow the format of the existing CHANGELOG for entry style:
```
- Category: Description
```
(e.g.,
```
- Core: ...
```
,
```
- Web: ...
```
).
Only write changes meaningful to users; do not include pure internal refactoring.
Chinese translations should follow the terminology mapping and typesetting guidelines in
```
docs/AGENTS.md
```
.