chore: update the release instruction

[sorrycc]

att

Summary by CodeRabbit

• 文档
  • 更新了 CONTRIBUTING.md 文件，明确了开发和发布流程，特别是发布前后的步骤。
• 新特性
  • 更新了 package.json 中的发布脚本，增加了新命令以优化发布过程。
  • @umijs/mako 包的版本已更新至 0.8.15。
• 重构
  • 简化了 release.ts 脚本的执行流程，增强了对工件管理的支持。

[coderabbitai]

Walkthrough

此拉取请求对多个文件进行了修改，主要集中在CONTRIBUTING.md和package.json文件上，以澄清mako项目的开发和发布流程。CONTRIBUTING.md中的发布部分进行了重组，强调了发布前的准备步骤，并增加了检查当前提交哈希的指令。package.json的release脚本被更新，以执行两个新的脚本。packages/mako/package.json的版本号也已更新，同时移除了两个不再需要的脚本。packages/mako/scripts/release.ts脚本的执行流程得到了简化，新增了处理工件的功能。

Changes

文件路径	变更摘要
CONTRIBUTING.md	更新发布部分，重组指令，增加检查当前提交哈希的步骤，强调$ just ready命令的重要性，扩展本地发布流程。
package.json	更新release脚本以执行release:mako和release:bundler-mako，移除旧的单一命令。
packages/mako/package.json	更新版本为0.8.15，移除release:quick和release:build脚本。
packages/mako/scripts/release.ts	重构release.ts脚本，简化流程，新增artifacts()函数处理工件，移除冗余逻辑。
scripts/release.ts	删除该文件，该文件原用于自动化发布流程，包括分支检查、版本提升和Git操作等。

Possibly related PRs

• docs: opt contributiong.md #1339: 此PR也修改了CONTRIBUTING.md文件，专注于结构性变更和澄清开发流程，与主PR中的发布指令更新相关。
• docs: change log 0923 #1607: 此PR更新了变更日志，以反映包括回滚优化在内的更改，相关于主PR讨论的整体文档和发布流程。

🐇 在兔子乐园中，
发布流程更清晰，
新脚本如春风，
工件管理更轻松，
贡献者欢声笑语，
版本号更新快如风，
一起加油，向前冲！ 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.97%. Comparing base (d49565e) to head (60d1f1e).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1627   +/-   ##
=======================================
  Coverage   61.97%   61.97%           
=======================================
  Files         155      155           
  Lines       15467    15467           
=======================================
  Hits         9585     9585           
  Misses       5882     5882           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (5)

package.json (1)

16-18: 发布流程的改进看起来很有前景

这些更改似乎旨在通过将发布过程拆分为更易管理的部分来改进发布流程。这种方法可能会提高发布过程的灵活性和可维护性。然而，在合并这些更改之前，请确保所有新脚本都经过了充分的测试，并且与现有的 CI/CD 流程兼容。

建议在合并之前，考虑以下几点：

1. 更新项目文档，反映新的发布流程。
2. 确保团队成员了解这些变更及其影响。
3. 考虑添加一些自动化测试，以验证新的发布流程在不同情况下的行为。

CONTRIBUTING.md (4)

169-173: 发布前的准备步骤很重要

添加发布前的检查步骤是一个很好的做法，可以确保发布过程的顺利进行。

建议稍微调整一下措辞，使其更加明确：

-Before release, please make sure everything is ok.
+在发布之前，请确保所有准备工作都已完成。

$ just ready

这样可以更清楚地表达这一步骤的重要性。

🧰 Tools

🪛 Markdownlint

172-172: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

175-179: 改进工件下载和提交哈希检查的说明

这些说明很有用，但可以进行一些改进：

1. 将裸 URL 格式化为适当的链接。
2. 修正语法错误（"artifacts has" 应为 "artifacts have"）。
3. 为提交哈希检查添加更多上下文。

建议如下修改：

-Open https://github.com/umijs/mako/actions?query=branch%3Amaster+event%3Apush to checkout the latest master push action with name "node-bind-build", and download the artifacts to packages/mako directory. If the artifacts has no commit hash in the name, you should add the commit hash manually.
+打开 [最新的主分支推送操作](https://github.com/umijs/mako/actions?query=branch%3Amaster+event%3Apush)，查找名为 "node-bind-build" 的操作，并将工件下载到 packages/mako 目录。如果工件名称中没有提交哈希，您应该手动添加提交哈希。

$ git rev-parse HEAD
+# 使用上面命令的输出作为提交哈希

这些更改将使说明更加清晰和准确。

🧰 Tools

🪛 LanguageTool

[grammar] ~175-~175: The word “checkout” is a noun. The verb is spelled with a white space.
Context: ...s?query=branch%3Amaster+event%3Apush to checkout the latest master push action with name...

(NOUN_VERB_CONFUSION)

---

[grammar] ~175-~175: It looks like you are using the wrong form of the noun or the verb. Did you mean “artifact has” or “artifacts have”?
Context: ...acts to packages/mako directory. If the artifacts has no commit hash in the name, you should ...

(NOUN_PLURAL_HAS)

🪛 Markdownlint

178-178: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

175-175: null
Bare URL used

(MD034, no-bare-urls)

---

181-184: 指定代码块的语言

为了提高可读性和语法高亮，建议为代码块指定语言：

-```
+```bash
# Release @umijs/mako and @umijs/bundler-mako
$ npm run release

这个小改动将使文档更加专业和易读。

🧰 Tools

🪛 Markdownlint

183-183: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

188-191: 发布后的重要步骤

添加这两个发布后的必要步骤是非常好的做法，有助于保持项目文档的更新和透明度。为了进一步提高清晰度，建议稍作调整：

After release, you must do 2 things:

-- Release the new version on github
-- Update the changelog in CHANGELOG.md and CHANGELOG_zh-CN.md
+1. 在 GitHub 上发布新版本
+2. 更新 CHANGELOG.md 和 CHANGELOG_zh-CN.md 中的更新日志

这样的编号和稍微详细的描述可以使步骤更加清晰。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d49565e and 60d1f1e.

📒 Files selected for processing (6)

• CONTRIBUTING.md (1 hunks)
• package.json (1 hunks)
• packages/mako/package.json (1 hunks)
• packages/mako/scripts/quick-release.ts (0 hunks)
• packages/mako/scripts/release.ts (4 hunks)
• scripts/release.ts (0 hunks)

💤 Files with no reviewable changes (2)

• packages/mako/scripts/quick-release.ts
• scripts/release.ts

🧰 Additional context used

🪛 LanguageTool

CONTRIBUTING.md

[grammar] ~175-~175: The word “checkout” is a noun. The verb is spelled with a white space.
Context: ...s?query=branch%3Amaster+event%3Apush to checkout the latest master push action with name...

(NOUN_VERB_CONFUSION)

---

[grammar] ~175-~175: It looks like you are using the wrong form of the noun or the verb. Did you mean “artifact has” or “artifacts have”?
Context: ...acts to packages/mako directory. If the artifacts has no commit hash in the name, you should ...

(NOUN_PLURAL_HAS)

🪛 Markdownlint

CONTRIBUTING.md

172-172: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

178-178: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

175-175: null
Bare URL used

(MD034, no-bare-urls)

---

183-183: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (9)

package.json (3)

18-18: 新增的 release:bundler-mako 脚本看起来不错，但需要验证 TypeScript 文件

使用 esno 直接运行 TypeScript 文件是一个很好的做法。不过，我们需要确保 release-bundler-mako.ts 文件存在且包含正确的逻辑。

请运行以下脚本来验证 release-bundler-mako.ts 文件：

#!/bin/bash
# 描述：验证 release-bundler-mako.ts 文件

# 测试：检查 release-bundler-mako.ts 文件是否存在
ls scripts/release-bundler-mako.ts

# 测试：检查 release-bundler-mako.ts 文件的内容
cat scripts/release-bundler-mako.ts

---

16-16: 发布脚本更新看起来不错，但需要验证新脚本

发布脚本的拆分提高了模块化程度，这是一个很好的改进。但是，我们需要确保新添加的脚本能够正常工作。

请运行以下脚本来验证新添加的脚本是否存在且可执行：

#!/bin/bash
# 描述：验证新的发布脚本是否存在且可执行

# 测试：检查 release:mako 和 release:bundler-mako 脚本是否存在
grep -E "release:mako|release:bundler-mako" package.json

# 测试：检查 scripts/release-bundler-mako.ts 文件是否存在
ls scripts/release-bundler-mako.ts

---

17-17: 新增的 release:mako 脚本看起来不错，但需要验证包配置

使用 pnpm 的 filter 功能来发布特定包是一个很好的做法。不过，我们需要确保 @umijs/mako 包存在且配置正确。

请运行以下脚本来验证 @umijs/mako 包的配置：

✅ Verification successful

release:mako 脚本已验证

@umijs/mako 包存在，且配置正确。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述：验证 @umijs/mako 包的配置

# 测试：检查 @umijs/mako 包是否存在
ls packages/mako/package.json

# 测试：检查 @umijs/mako 包的 package.json 中是否包含 release 脚本
grep "release" packages/mako/package.json

Length of output: 323

packages/mako/package.json (2)

88-88: 移除了 release:quick 和 release:build 脚本

release:quick 和 release:build 脚本已从 package.json 中移除。这可能表明发布流程已经更改。

请运行以下脚本以验证这些脚本的移除是否影响了项目的其他部分：

#!/bin/bash
# 描述：检查是否有其他文件仍在引用已删除的脚本

# 测试：搜索可能引用已删除脚本的文件
rg --type md --type yaml --type json --type ts "release:quick|release:build"

另外，请确认这些脚本的功能是否已被其他脚本或流程所取代。如果有新的发布流程，建议更新相关文档以反映这些变化。

---

Line range hint 3-3: 版本更新至 0.8.15

版本号已从之前的版本更新到 0.8.15。这是一个小版本更新，通常用于引入向后兼容的新功能或非破坏性的更改。

请运行以下脚本以验证版本更新是否与其他相关文件同步：

✅ Verification successful

修正版本引用检查脚本

先前的脚本未能正确搜索版本号引用。请运行以下修正后的脚本以验证版本更新是否已同步到其他相关文件：

---

检查已移除脚本的引用

为了确保移除"release:quick"和"release:build"脚本不会影响其他部分，请运行以下脚本以查找代码库中是否仍有对此类脚本的引用：

---

全面检查已移除脚本的引用

为了确保移除"release:quick"和"release:build"脚本不会影响其他部分，请运行以下脚本以在所有相关文件中查找对此类脚本的引用：

---

版本更新和脚本移除已验证通过

版本已成功更新至 0.8.15，并且移除的脚本 "release:quick" 和 "release:build" 在代码库中未被引用，不会影响项目的其他部分。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述：检查其他文件中的版本引用是否已更新

# 测试：搜索可能包含版本号的文件
rg --type md --type yaml --type json "0\.8\.(14|15)"

Length of output: 78

---

Script:

#!/bin/bash
# 描述：检查其他文件中的版本引用是否已更新

# 测试：搜索可能包含版本号的文件
rg --type md --type yaml --type json "0\.8\.(14|15)"

Length of output: 2545

---

Script:

#!/bin/bash
# 描述：检查代码库中是否还有对已移除脚本的引用

# 测试：搜索可能引用已移除脚本的文件
rg --type md --type yaml --type json "release:quick|release:build"

Length of output: 68

---

Script:

#!/bin/bash
# 描述：全面检查代码库中是否还有对已移除脚本的引用

# 测试：在所有文件类型中搜索"release:quick"和"release:build"
rg "release:quick|release:build"

Length of output: 34

packages/mako/scripts/release.ts (4)

1-1: 建议：确认assert模块的依赖

在第1行，您导入了assert模块。请确保项目的依赖中包含了assert，以避免在运行时出现模块未找到的错误。

---

13-13: 直接调用run()函数，可能影响执行流程

在第13行，您直接调用了await run();，之前可能存在条件判断来决定是否调用build()或run()。请确认这种更改不会对脚本的执行流程产生不良影响，特别是在需要仅构建而不发布的情况下。

---

35-35: 在发布流程中调用artifacts()函数，需确认执行顺序

在第35行，您在run()函数中调用了await artifacts(artifactsFile);。请确保在调用此函数之前，所有依赖的构建步骤已经完成，且artifactsFile已正确生成。

---

49-51: 更新构建命令，需验证新构建流程的有效性

在第49-51行，您更改了build()函数中的构建命令，改为使用pnpm run build、pnpm run src:build和pnpm run format。请验证这些命令能够正确执行，并符合项目的构建需求。

[coderabbitai]

⚠️ Potential issue

增加了对artifacts文件的依赖，需确保文件存在

在第22-25行，您增加了获取commitId并检查对应的artifacts-${commitId}.zip文件是否存在的逻辑。这意味着发布流程现在依赖于此文件的存在。请确保在发布前已经生成了该文件，并放置在正确的目录中。

---

🛠️ Refactor suggestion

重复检查artifacts文件，可能存在冗余

您在run()函数中检查了artifacts文件是否存在（第22-25行），并在artifacts()函数中再次对该文件进行操作（第56行）。这可能导致冗余的检查和操作。建议将文件存在性检查和操作集中在一个地方，优化代码结构。

Also applies to: 54-57

[coderabbitai]

⚠️ Potential issue

新增加的artifacts()函数缺少错误处理

在第54-57行，您新增了artifacts(artifactsFile: string)函数，但其中的文件操作缺少错误处理。如果unzip失败或artifactsFile不存在，脚本将会崩溃。建议增加错误处理以提高脚本的健壮性。

可以考虑如下修改，添加错误捕获：

async function artifacts(artifactsFile: string) {
+ try {
    await $`rm -rf *.node`;
    await $`unzip ${artifactsFile}`;
    await $`npm run artifacts:local`;
+ } catch (error) {
+   console.error(`Artifacts processing failed: ${error}`);
+   process.exit(1);
+ }
}

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	async function artifacts(artifactsFile: string) {
	await $`rm -rf *.node`;
	await $`unzip ${artifactsFile}`;
	await $`npm run artifacts:local`;
	async function artifacts(artifactsFile: string) {
	try {
	await $`rm -rf *.node`;
	await $`unzip ${artifactsFile}`;
	await $`npm run artifacts:local`;
	} catch (error) {
	console.error(`Artifacts processing failed: ${error}`);
	process.exit(1);
	}
	}