@modern-js/main-doc 0.0.0-next-1686023023547 → 0.0.0-next-1686044917772

package/docs/zh/guides/topic-detail/changesets/release.mdx

@@ -4,7 +4,7 @@ sidebar_position: 3
 
 # 发布正式版本
 
-发版正式版本时，我们需要根据开发过程中生成的 changeset 进行相关包版本号升级，并执行 publish 命令发布到 NPM 上。
+发版正式版本时，我们需要根据开发过程中生成的 changesets 进行相关包版本号升级，并执行 publish 命令发布到 NPM 上。
 
 ## 步骤
 
@@ -15,7 +15,7 @@ sidebar_position: 3
 
 ### 模块工程方案
 
-#### 在根目录执行以下命令：
+#### 在根目录执行 bump 命令
 
 ```bash
 pnpm run bump
@@ -29,16 +29,16 @@ pnpm run bump
 
 - 根据 changeset 信息升级该包版本号。
 
-- 在根目录的 `CHANGELOG.md` 文件中写入 Changelog 信息，文件不存在时会自动创建。
+- 在根目录的 `CHANGELOG.md` 文件中写入 changelog 信息，文件不存在时会自动创建。
 
-#### 确认并提交当前变更：
+#### 确认并提交当前变更
 
 ```bash
 git add .
 git commit -m "release: bump package"
 ```
 
-#### 在根目录执行以下命令发布包至 NPM：
+#### 在根目录执行以下命令发布包至 NPM
 
 ```bash
 pnpm run release
@@ -46,7 +46,7 @@ pnpm run release
 
 ![执行 release 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-module-release.png)
 
-#### push 对应的 tag 信息至远程仓库：
+#### push 对应的 tag 信息至远程仓库
 
 ```bash
 git push --follow-tags
@@ -54,7 +54,7 @@ git push --follow-tags
 
 ### Monorepo 工程方案
 
-#### 在根目录执行以下命令：
+#### 在根目录执行 bump 命令
 
 ```bash
 pnpm run bump
@@ -62,7 +62,7 @@ pnpm run bump
 
 ![执行 bump 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-monorepo-bump.png)
 
-执行该命令时，changeset 会自动进行以下操作：
+执行该命令时，changesets 会自动进行以下操作：
 
 - 删除 `.changesets` 目录下的所有 changeset 文件。
 
@@ -70,7 +70,7 @@ pnpm run bump
 
 - 在需要升级的包目录的 `CHANGELOG.md` 文件中写入 Changelog 信息，文件不存在时会自动创建。
 
-#### 确认并提交当前变更：
+#### 确认并提交当前变更
 
 :::info
 需确认自动升级的版本号是否符合预期，如果需要了解版本升级策略，请查看[升级版本策略](/guides/topic-detail/changesets/release#升级版本策略)。
@@ -82,7 +82,7 @@ git add .
 git commit -m "release: bump package"
 ```
 
-#### 在根目录执行以下命令发布包至 NPM：
+#### 在根目录执行以下命令发布包至 NPM
 
 ```bash
 pnpm run release
@@ -95,7 +95,7 @@ pnpm run release
 
 :::
 
-#### push 对应的 tag 信息至远程仓库：
+#### push 对应的 tag 信息至远程仓库
 
 ```bash
 git push --follow-tags
@@ -105,22 +105,22 @@ git push --follow-tags
 
 ### bump 命令参数
 
-- `--snapshot` 生成基于时间戳的版本号。
+- `--snapshot`：生成基于时间戳的版本号。
 
 ```bash
-pnpm run bump -- --snapshot canary
+pnpm run bump --snapshot canary
 ```
 
 执行完成后，对应的升级版本号将会变成 `0.0.0-canary-20220622092823` 的形式，其中 canary 为 snapshot 配置的标记，如果不配置，将直接生成 `0.0.0-20220622092823` 的形式。
 
 该参数主要用于发布临时测试版本进行测试，不需要进行代码提交。
 
-- `--ignore` 发布时手动忽略部分包。
+- `--ignore`：发布时手动忽略部分包。
 
 例如本次发布你需要忽略 `module-2` 包：
 
 ```bash
-pnpm run bump -- --ignore module-2
+pnpm run bump --ignore module-2
 ```
 
 命令执行完成后，将会忽略 `module-2` 包的更新。注意如果存在包依赖 `module-2`，需要将对应包也加入到 `ignore` 参数中，否则 `bump` 命令将执行失败。
@@ -128,44 +128,44 @@ pnpm run bump -- --ignore module-2
 加入多个包的使用姿势为：
 
 ```bash
-pnpm run bump -- --ignore module-2 --ignore module-3
+pnpm run bump --ignore module-2 --ignore module-3
 ```
 
 ### release 命令参数
 
-- `--otp` 使用 `npm token` 执行 release 命令发布对应包
+- `--otp`：使用 `npm token` 发布包。
 
 ```bash
-pnpm run relese -- --otp <token>
+pnpm run relese --otp <token>
 ```
 
-- `--tag` 本地发布使用特定的 tag，默认使用 `latest`
+- `--tag`：发布使用特定的 tag，默认使用 `latest`
 
 ```bash
-pnpm run release -- --tag <tag>
+pnpm run release --tag <tag>
 ```
 
-- `--ignore-scripts` 发布时忽略 npm scripts。
+- `--ignore-scripts`：发布时忽略 npm scripts。
 
 执行 `publish` 命令时，npm 会自动触发很多命令，比如 `prepare`、`prepublish`，使用该参数可以忽略这些命令执行。该参数仅支持在使用 pnpm 的 Monorepo 中使用。
 
 ```bash
-pnpm run release -- --ignore-scripts
+pnpm run release --ignore-scripts
 ```
 
-- `--no-git-checks` 发布时忽略检查当前分支。
+- `--no-git-checks`：发布时忽略检查当前分支。
 
 执行发布命令时，默认会自动检查当前分支是否为发布分支，是否存在未提交变更等等，使用该参数可以忽略 git 相关检查。
 
 ```bash
-pnpm run release -- --no-git-checks
+pnpm run release --no-git-checks
 ```
 
 ## 升级版本策略
 
 ### dependencies 或者 devDependencies 依赖
 
-#### patch 版本依赖只升级自身
+- patch 版本依赖只升级自身
 
 例如存在如下场景：
 
@@ -175,7 +175,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 `depend
 
 执行 bump 命令后将只会升级 `module-1` 的 patch 版本号。
 
-#### major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 patch 版本号
+- major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 patch 版本号
 
 例如存在如下场景：
 
@@ -187,7 +187,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 depende
 
 ### peerDependencies 依赖
 
-#### patch 版本依赖自身和依赖包都升级 patch 版本号
+- patch 版本依赖自身和依赖包都升级 patch 版本号
 
 例如存在如下场景：
 
@@ -197,7 +197,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 `peerDe
 
 执行 bump 命令后将 `module-1` 和 `module-2` 都升级 patch 版本号。
 
-#### major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 major 版本号
+- major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 major 版本号
 
 例如存在如下场景：
 
@@ -207,7 +207,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 `peerDe
 
 执行 bump 命令后将 module-1 将升级 `minor` 版本号， `module-2` 升级 `major` 版本号。
 
-#### 修改 peerDependencies 的升级策略
+- 修改 peerDependencies 的升级策略
 
 `peerDependencies` 的升级策略支持通过配置 `onlyUpdatePeerDependentsWhenOutOfRange` 来修改依赖升级策略，当只有超出声明的版本类型范围时，才对应升级 `peerDependencies`。
 

package/package.json

@@ -15,13 +15,13 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-1686023023547",
+  "version": "0.0.0-next-1686044917772",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-1686023023547"
+    "@modern-js/builder-doc": "0.0.0-next-1686044917772"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -33,9 +33,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-1686023023547",
-    "@modern-js/doc-tools": "0.0.0-next-1686023023547",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686023023547"
+    "@modern-js/builder-doc": "0.0.0-next-1686044917772",
+    "@modern-js/doc-tools": "0.0.0-next-1686044917772",
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686044917772"
   },
   "scripts": {
     "dev": "modern dev",