@modern-js/main-doc 0.0.0-next-1685988387703 → 0.0.0-next-1686037191101

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

@@ -9,11 +9,15 @@ Modern.js 提供了 `modern gen-release-note` 命令，支持通过当前存在
 默认生成的 Release Note 格式为：
 
 ```markdown
-[[#1220](https://github.com/web-infra-dev/modern.js/pull/1220)] feat: support bff operators -- Ming
+- fix: add missing type definitions by @zllkjc in https://github.com/web-infra-dev/modern.js/pull/3835
 ```
 
 根据 commit 信息获取 changeset 的 Pull Request ID，并生成 Github 的链接，内容为 changeset 的 changelog 信息和作者信息。
 
+:::info
+获取作者信息，需要提供 Github Token 环境变量，通过 GITHUB_AUTH_TOKEN 传入。
+:::
+
 当默认生成 Release Note 逻辑不能满足需求时，支持自定义 Release Note 格式。
 
 ## 信息
@@ -34,7 +38,7 @@ Modern.js 提供了 `modern gen-release-note` 命令，支持通过当前存在
 
 当前 changeset 对应的 commit message 信息。
 
-执行 `git log --pretty=format:%h--%s--%an .changeset/${changeset.id}.md` 的结果。
+执行 `git log --pretty=format:%h--%s--%ae .changeset/${changeset.id}.md` 的结果。
 
 - commitObj
 
@@ -49,6 +53,7 @@ interface Commit {
   author?: string;
   message: string; // commit message
   summary: string; // changeset summary
+  summary_zh: string; // changeset zh summary
   [key: string]: string | undefined;
 }
 ```
@@ -59,15 +64,37 @@ commitObj， 补充后完整的 commit 对象。
 
 ##### 默认实现
 
-Modern.js 的默认实现为：根据 commit 信息拆分出 Pull Request ID 和作者，加入到 commitObj 中。
+Modern.js 的默认实现为：根据 commit 信息拆分出 Pull Request ID，并根据 commit id 获取到用户信息，加入到 commitObj 中。
 
 ```ts
 function getReleaseInfo(commit: string, commitObj: Commit) {
-  const commitRegex = /(.*)\(#(\d*)\)/;
-
-  const [, message, author] = commit.split('--');
-
-  commitObj.author = author;
+const commitRegex = /(.*)\(#(\d*)\)/;
+
+  const [commitId, message, email] = commit.split('--');
+
+  const author = AuthorMap.get(email);
+  const token = authToken || process.env.GITHUB_AUTH_TOKEN;
+  if (author) {
+    commitObj.author = author;
+  } else if (repo && token) {
+    try {
+      const res = await axios.get(
+        `https://api.github.com/repos/${repo}/commits/${commitId}`,
+        {
+          method: 'GET',
+          headers: {
+            'Content-Type': 'application/json',
+            Authorization: token,
+          },
+        },
+      );
+      const author = res.data.author.login;
+      commitObj.author = author;
+      AuthorMap.set(email, author);
+    } catch (e) {
+      console.warn(e);
+    }
+  }
 
   if ((message || commitObj.summary).match(commitRegex)) {
     const [, messageShort, pullRequestId] = (
@@ -95,6 +122,12 @@ function getReleaseInfo(commit: string, commitObj: Commit) {
 
 类型和上述 commitObj 类型一致。
 
+- lang
+
+类型： string;
+
+获取对应语言的 Release Note 信息，支持 `en` 和 `zh`，默认为 `en`。
+
 ##### 返回值
 
 生成的 Release Note。
@@ -104,52 +137,29 @@ function getReleaseInfo(commit: string, commitObj: Commit) {
 Modern.js 的默认实现为：
 
 ```ts
-function formatSummary(summary: string, pullRequestId?: string) {
-  const [firstLine, ...futureLines] = summary
-    .split('\n')
-    .map(l => l.trimRight());
-
-  let returnVal = firstLine;
-
-  if (futureLines.length > 0) {
-    if (pullRequestId) {
-      returnVal = `\n\n  ${returnVal}`;
-    } else {
-      returnVal = `\n  ${returnVal}`;
-    }
-    returnVal += `\n\n  ${futureLines
-      .filter(l => Boolean(l))
-      .map(l => l)
-      .join('\n\n')}`;
-  }
-  return returnVal;
-}
-
-export async function getReleaseNoteLine(
+export function getReleaseNoteLine(
   commit: Commit,
-  customReleaseNoteFunction?: CustomReleaseNoteFunction,
+  lang: 'en' | 'zh' = 'en',
 ) {
-  if (customReleaseNoteFunction?.getReleaseNoteLine) {
-    return customReleaseNoteFunction.getReleaseNoteLine(commit);
-  }
-
-  const { repository, pullRequestId, summary } = commit;
-  if (pullRequestId && repository) {
-    return `- [#${pullRequestId}](https://github.com/${repository}/pull/${pullRequestId}) ${formatSummary(
-      summary,
-      pullRequestId,
-    )}\n`;
-  }
-  if (pullRequestId) {
-    return `#${pullRequestId} ${formatSummary(summary, pullRequestId)}\n`;
+  const { repository, pullRequestId, summary, summary_zh, author } = commit;
+  const pullRequest =
+    pullRequestId && repository
+      ? `https://github.com/${repository}/pull/${pullRequestId}`
+      : '';
+  if (lang === 'en') {
+    return `- ${summary}${author ? ` by @${author}` : ''}${
+      pullRequest ? ` in ${pullRequest}` : ''
+    }\n`;
   }
-  return `${formatSummary(summary, pullRequestId)}\n`;
+  return `- ${summary_zh}${author ? ` 由 @${author} 实现` : ''}${
+    pullRequest ? `， 详情可查看 ${pullRequest}` : ''
+  }\n`;
 }
 ```
 
 ## 使用自定义模块
 
-`gen-release-note` 命令支持 `--custom` 参数，该参数可传入自定义 release note 模块的模块名称或者路径。
+`gen-release-note` 命令支持 `--custom` 参数，该参数可传入自定义 Release Note 模块的模块名称或者路径。
 
 ### 配置相对路径
 
@@ -173,7 +183,7 @@ module.exports = {
 执行下面命令：
 
 ```bash
-pnpm run gen-release-note -- --custom ./scripts/my-release-note-config.js
+pnpm run gen-release-note --custom ./scripts/my-release-note-config.js
 ```
 
 也可以把命令参数直接定义到 package.json 中：
@@ -216,7 +226,7 @@ export function getReleaseNoteLine() {}
 5. 执行 gen-release-note 命令添加 custom 参数
 
 ```bash
-pnpm run gen-release-note -- --custom custom-release-note
+pnpm run gen-release-note --custom custom-release-note
 ```
 
 ### 使用 Monorepo 工程方案
@@ -253,7 +263,7 @@ export function getReleaseNoteLine() {}
 4. 执行 `gen-release-note` 命令添加 `--custom` 参数
 
 ```bash
-pnpm run gen-release-note -- --custom custom-release-note
+pnpm run gen-release-note --custom custom-release-note
 ```
 
 该模块发布到 NPM 后，依然可以和模块类型一样供其他仓库使用。

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

@@ -4,7 +4,7 @@ sidebar_position: 4
 
 # 发布预发布版本
 
-在发布正式版本之前，我们也需要发布预发布版本供内部测试和用户使用，Changesets 也支持发布预发布版本。
+在发布正式版本之前，我们也需要发布预发布版本供内部测试和用户使用，changesets 也支持发布预发布版本。
 
 ## 步骤
 
@@ -16,7 +16,7 @@ sidebar_position: 4
 #### 执行以下命令升级预发布版本版本号：
 
 ```bash
-pnpm run bump -- --canary --preid <preid>
+pnpm run bump --canary --preid <preid>
 ```
 
 `preid` 为预发布版本标记，例如 `alpha`、`beta` 等，默认值为 `next`。
@@ -38,7 +38,7 @@ pnpm run bump -- --canary --preid <preid>
 #### 执行以下命令发布预发布版本：
 
 ```bash
-pnpm run release -- --tag <tag>
+pnpm run release --tag <tag>
 ```
 
 发布预发布版本一定要使用 `--tag` 参数，参数值最好和 `preid` 值相同，方便用户使用。
@@ -47,4 +47,4 @@ pnpm run release -- --tag <tag>
 
 ### 退出预发布模式
 
-在进入预发布模式后，Changesets 会自动在 `.changeset` 目录创建 `pre.json` 文件用于记录当时进入预发布模式的一些状态信息，当出现状态信息和当前仓库状态不一致时，可直接删除该文件退出预发布模式。
+在进入预发布模式后，changesets 会自动在 `.changeset` 目录创建 `pre.json` 文件用于记录当时进入预发布模式的一些状态信息，当出现状态信息和当前仓库状态不一致时，可直接删除该文件退出预发布模式。

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

@@ -108,7 +108,7 @@ git push --follow-tags
 - `--snapshot` 生成基于时间戳的版本号。
 
 ```bash
-pnpm run bump -- --snapshot canary
+pnpm run bump --snapshot canary
 ```
 
 执行完成后，对应的升级版本号将会变成 `0.0.0-canary-20220622092823` 的形式，其中 canary 为 snapshot 配置的标记，如果不配置，将直接生成 `0.0.0-20220622092823` 的形式。
@@ -120,7 +120,7 @@ pnpm run bump -- --snapshot canary
 例如本次发布你需要忽略 `module-2` 包：
 
 ```bash
-pnpm run bump -- --ignore module-2
+pnpm run bump --ignore module-2
 ```
 
 命令执行完成后，将会忽略 `module-2` 包的更新。注意如果存在包依赖 `module-2`，需要将对应包也加入到 `ignore` 参数中，否则 `bump` 命令将执行失败。
@@ -128,7 +128,7 @@ 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 命令参数
@@ -136,13 +136,13 @@ pnpm run bump -- --ignore module-2 --ignore module-3
 - `--otp` 使用 `npm token` 执行 release 命令发布对应包
 
 ```bash
-pnpm run relese -- --otp <token>
+pnpm run relese --otp <token>
 ```
 
 - `--tag` 本地发布使用特定的 tag，默认使用 `latest`
 
 ```bash
-pnpm run release -- --tag <tag>
+pnpm run release --tag <tag>
 ```
 
 - `--ignore-scripts` 发布时忽略 npm scripts。
@@ -150,7 +150,7 @@ pnpm run release -- --tag <tag>
 执行 `publish` 命令时，npm 会自动触发很多命令，比如 `prepare`、`prepublish`，使用该参数可以忽略这些命令执行。该参数仅支持在使用 pnpm 的 Monorepo 中使用。
 
 ```bash
-pnpm run release -- --ignore-scripts
+pnpm run release --ignore-scripts
 ```
 
 - `--no-git-checks` 发布时忽略检查当前分支。
@@ -158,7 +158,7 @@ pnpm run release -- --ignore-scripts
 执行发布命令时，默认会自动检查当前分支是否为发布分支，是否存在未提交变更等等，使用该参数可以忽略 git 相关检查。
 
 ```bash
-pnpm run release -- --no-git-checks
+pnpm run release --no-git-checks
 ```
 
 ## 升级版本策略

package/package.json

@@ -15,13 +15,13 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-1685988387703",
+  "version": "0.0.0-next-1686037191101",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-1685988387703"
+    "@modern-js/builder-doc": "0.0.0-next-1686037191101"
   },
   "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-1685988387703",
-    "@modern-js/doc-tools": "0.0.0-next-1685988387703",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1685988387703"
+    "@modern-js/builder-doc": "0.0.0-next-1686037191101",
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686037191101",
+    "@modern-js/doc-tools": "0.0.0-next-1686037191101"
   },
   "scripts": {
     "dev": "modern dev",