changelog

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Changelog Skill

变更日志技能

Changelogs are auto-generated by

@semantic-release/changelog

on each release.

变更日志由

@semantic-release/changelog

在每次发布时自动生成。

How It Works

工作原理

semantic-release runs on push to
```
main
```
```
@semantic-release/release-notes-generator
```
generates notes from commits (conventionalcommits preset)
```
@semantic-release/changelog
```
prepends notes to
```
CHANGELOG.md
```
```
@semantic-release/git
```
commits the updated changelog

当代码推送到
```
main
```
分支时，semantic-release启动运行
```
@semantic-release/release-notes-generator
```
根据提交记录生成发布说明（使用conventionalcommits预设）
```
@semantic-release/changelog
```
将生成的说明添加到
```
CHANGELOG.md
```
的开头
```
@semantic-release/git
```
提交更新后的变更日志

Changelog Sections

变更日志章节

Commit types map to changelog sections:

Commit Type	Changelog Section
`feat`	Features
`fix`	Bug Fixes
`perf`	Performance Improvements
`revert`	Reverts
`feat!` / `BREAKING CHANGE`	BREAKING CHANGES

Types

chore

docs

refactor

test

ci

do not appear in the changelog.

提交类型对应不同的变更日志章节：

提交类型	变更日志章节
`feat`	新功能
`fix`	问题修复
`perf`	性能优化
`revert`	回滚操作
`feat!` / `BREAKING CHANGE`	重大变更

chore

、

docs

、

refactor

、

test

、

ci

类型的提交不会出现在变更日志中。

Viewing Changelog

查看变更日志

bash

undefined

bash

undefined

View the changelog file

查看变更日志文件

cat CHANGELOG.md

View a specific GitHub release's notes

查看GitHub特定版本的发布说明

gh release view v4.46.0

List recent releases with dates

列出最近的10个版本及日期

gh release list --limit 10

undefined

gh release list --limit 10

undefined

Missing Changelog Entry?

变更日志条目缺失？

If a commit does not appear in the changelog:

Check the commit type — only
```
feat
```
,
```
fix
```
,
```
perf
```
,
```
revert
```
generate entries
Verify the commit landed on
```
main
```
(not a feature branch)
Check if semantic-release ran:
```
gh run list --workflow=release.yml
```
Ensure commit message follows conventional format

如果某个提交未出现在变更日志中：

检查提交类型——只有
```
feat
```
、
```
fix
```
、
```
perf
```
、
```
revert
```
类型会生成条目
确认该提交已合并到
```
main
```
分支（而非功能分支）
检查semantic-release是否运行：
```
gh run list --workflow=release.yml
```
确保提交信息符合约定式提交格式

File Location

文件位置

Changelog:
```
CHANGELOG.md
```
(root of repository)

Config:

.releaserc.json

→

@semantic-release/changelog

plugin

变更日志：
```
CHANGELOG.md
```
（仓库根目录）

配置文件：

.releaserc.json

→

@semantic-release/changelog

插件