diff --git a/docs/cli/changelog.md b/docs/cli/changelog.md index d220eef..3cf5244 100644 --- a/docs/cli/changelog.md +++ b/docs/cli/changelog.md @@ -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']` | diff --git a/docs/cli/release.md b/docs/cli/release.md index ad3554c..3ef33dc 100644 --- a/docs/cli/release.md +++ b/docs/cli/release.md @@ -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 diff --git a/docs/zh/cli/changelog.md b/docs/zh/cli/changelog.md index 5412f5e..f6d0c3e 100644 --- a/docs/zh/cli/changelog.md +++ b/docs/zh/cli/changelog.md @@ -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']`。 | diff --git a/docs/zh/cli/release.md b/docs/zh/cli/release.md index 4036031..7cd847f 100644 --- a/docs/zh/cli/release.md +++ b/docs/zh/cli/release.md @@ -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 远程版本,若版本已存在则退出流程 | ### 配置