Skip to content

docs: update changelog and release documentation #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haoziqaq merged 1 commit into from
Apr 16, 2026
+4 −4
Merged

docs: update changelog and release documentation #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ await changelog({
| --- | --- | --- | --- |
| `file` | `string` | - | Output file path |
| `releaseCount` | `number` | `0` | Number of releases to generate, `0` means all |
| `showTypes` | `string[]` | - | Commit types to include (e.g. `'feat'`, `'fix'`, `'perf'`) |
| `showTypes` | `string[]` | `[feat, fix, perf, revert, refactor]` | You can customize which types of commit messages are displayed in the `CHANGELOG.md`. For example, passing in `[feat, fix]` will only generate commit information for the `Features` and Bug `Fixes types`. You are free to combine any of the following types: `['feat', 'fix', 'perf', 'revert', 'refactor', 'docs', 'style', 'test', 'build', 'ci']` |
2 changes: 1 addition & 1 deletion docs/cli/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All options can be passed as command-line arguments. CLI arguments take priority
| `--skip-npm-publish` | Skip npm publish |
| `--skip-changelog` | Skip changelog generation |
| `--skip-git-tag` | Skip git tag |
| `-c, --check-remote-version` | Skip publish if the current version already exists on npm |
| `-c, --check-remote-version` | Exit if the current version already exists on npm |

### Config

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/cli/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ await changelog({
| --- | --- | --- | --- |
| `file` | `string` | - | 输出文件路径 |
| `releaseCount` | `number` | `0` | 生成的发布版本数量，`0` 表示全量生成 |
| `showTypes` | `string[]` | - | 包含的 commit 类型 (如 `'feat'`、`'fix'`、`'perf'`) |
| `showTypes` | `string[]` | `[feat, fix, perf, revert, refactor]` | 自定义在 `CHANGELOG.md` 中显示哪些类型的提交消息。例如，传入 `[feat, fix]` 将仅生成 `Features` 和 ` Bug Fixes` 类型的提交信息。可从从以下类型中自由组合：`['feat', 'fix', 'perf', 'revert', 'refactor', 'docs', 'style', 'test', 'build', 'ci']`。 |
2 changes: 1 addition & 1 deletion docs/zh/cli/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ rt release --check-remote-version --remote upstream
| `--skip-npm-publish` | 跳过 npm 发布 |
| `--skip-changelog` | 跳过 changelog 生成 |
| `--skip-git-tag` | 跳过 git tag |
| `-c, --check-remote-version` | 发布前检查 npm 远程版本，若版本已存在则跳过发布 |
| `-c, --check-remote-version` | 发布前检查 npm 远程版本，若版本已存在则退出流程 |

### 配置

Expand Down
Loading