Skip to content

Commit c94481f

Browse files
authored
docs: update changelog and release documentation (#47)
1 parent d36c504 commit c94481f

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/cli/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ await changelog({
4242
| --- | --- | --- | --- |
4343
| `file` | `string` | - | Output file path |
4444
| `releaseCount` | `number` | `0` | Number of releases to generate, `0` means all |
45-
| `showTypes` | `string[]` | - | Commit types to include (e.g. `'feat'`, `'fix'`, `'perf'`) |
45+
| `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']` |

docs/cli/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ All options can be passed as command-line arguments. CLI arguments take priority
2323
| `--skip-npm-publish` | Skip npm publish |
2424
| `--skip-changelog` | Skip changelog generation |
2525
| `--skip-git-tag` | Skip git tag |
26-
| `-c, --check-remote-version` | Skip publish if the current version already exists on npm |
26+
| `-c, --check-remote-version` | Exit if the current version already exists on npm |
2727

2828
### Config
2929

docs/zh/cli/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ await changelog({
4242
| --- | --- | --- | --- |
4343
| `file` | `string` | - | 输出文件路径 |
4444
| `releaseCount` | `number` | `0` | 生成的发布版本数量,`0` 表示全量生成 |
45-
| `showTypes` | `string[]` | - | 包含的 commit 类型 (如 `'feat'``'fix'``'perf'`) |
45+
| `showTypes` | `string[]` | `[feat, fix, perf, revert, refactor]` | 自定义在 `CHANGELOG.md` 中显示哪些类型的提交消息。例如,传入 `[feat, fix]` 将仅生成 `Features`` Bug Fixes` 类型的提交信息。可从从以下类型中自由组合:`['feat', 'fix', 'perf', 'revert', 'refactor', 'docs', 'style', 'test', 'build', 'ci']` |

docs/zh/cli/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ rt release --check-remote-version --remote upstream
2323
| `--skip-npm-publish` | 跳过 npm 发布 |
2424
| `--skip-changelog` | 跳过 changelog 生成 |
2525
| `--skip-git-tag` | 跳过 git tag |
26-
| `-c, --check-remote-version` | 发布前检查 npm 远程版本,若版本已存在则跳过发布 |
26+
| `-c, --check-remote-version` | 发布前检查 npm 远程版本,若版本已存在则退出流程 |
2727

2828
### 配置
2929

0 commit comments

Comments
 (0)