@rsdoctor/docs 1.4.1-beta.0 → 1.5.0

package/docs/en/config/options/experiments.mdx

@@ -8,7 +8,7 @@ import { Badge } from '@theme';
 
 - **Type:** `boolean`
 - **Optional:** `true`
-- **Default:** `false`
+- **Default:** `true`
 
 By enabling the enableNativePlugin option, the Rspack native plugin moves the time-consuming data processing logic from Rsdoctor to the Rspack build stage, significantly improving build analysis efficiency and greatly reducing Rsdoctor's own analysis time.
 

package/docs/en/config/options/options.mdx

@@ -122,7 +122,7 @@ interface RsdoctorWebpackPluginOptions<
 interface RsdoctorRspackPluginExperiments {
   /**
    * Whether to enable native plugin to improve performance
-   * @default false
+   * @default true
    */
   enableNativePlugin?: boolean;
 }

package/docs/en/config/options/output.mdx

@@ -194,7 +194,9 @@ NormalModeOptions currently has an empty Object type.
 
 ```js
 new RsdoctorRspackPlugin({
-  reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
+  output: {
+    reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
+  }
 }),
 ```
 

package/docs/en/guide/start/action.mdx

@@ -58,9 +58,12 @@ Create a `.github/workflows/ci.yml` file in your GitHub repository as shown in t
 target_branch: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
 ```
 
-- `on` indicates when the workflow runs, commonly set to `pull_request` and `push`.
+- `dispatch_target_branch`: Optional, used to specify the target branch when manually triggered (workflow_dispatch).
+
+- `on` indicates when the workflow runs, commonly set to `pull_request` and `push`, and also supports `workflow_dispatch` for manual triggering.
   - On `pull_request`, Rsdoctor Action fetches baseline and current and performs bundle diff analysis.
   - On `push` (i.e., after PR merge), it updates and uploads the baseline.
+  - `workflow_dispatch` allows you to manually trigger the workflow from the GitHub Actions page. This mode combines the behavior of `push` and `pull_request`: it uploads baseline data, and if `dispatch_target_branch` is specified, it also performs baseline comparison analysis.
 - Before executing rsdoctor-action, build your project with the Rsdoctor plugin enabled to generate the Rsdoctor JSON data file.
 
 ```yaml
@@ -72,6 +75,13 @@ on:
   push:
     branches:
       - main # or your target branch name
+  workflow_dispatch: # Optional, allows manual triggering
+    inputs:
+      target_branch:
+        description: 'Target branch to compare against'
+        required: false
+        default: 'main'
+        type: string
 
 jobs:
   bundle-analysis:
@@ -115,6 +125,8 @@ jobs:
           # Default 'main'. If you want to use a dynamic target branch, i.e., automatically get the target branch of the current pull request instead of a fixed main branch, you can use the following configuration:
           # ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
           target_branch: 'main'
+          # Target branch for manual trigger
+          dispatch_target_branch: ${{ github.event.inputs.target_branch }}
 ```
 
 ## View Reports

package/docs/zh/config/options/experiments.mdx

@@ -8,7 +8,7 @@ import { Badge } from '@theme';
 
 - **类型：** `boolean`
 - **可选：** `true`
-- **默认值：** `false`
+- **默认值：** `true`
 
 通过 enableNativePlugin 选项开启 Rspack 原生插件，将 Rsdoctor 中耗时较大的数据处理逻辑前置到 Rspack 构建阶段，从而显著提升构建分析效率并大幅降低 Rsdoctor 自身的分析耗时。
 

package/docs/zh/config/options/options.mdx

@@ -121,7 +121,7 @@ interface RsdoctorWebpackPluginOptions<
 interface RsdoctorRspackPluginExperiments {
   /**
    * 是否启用原生插件以提高性能
-   * @default false
+   * @default true
    */
   enableNativePlugin?: boolean;
 }

package/docs/zh/config/options/output.mdx

@@ -191,7 +191,9 @@ NormalModeOptions 目前类型为空 Object。
 
 ```js
 new RsdoctorRspackPlugin({
-  reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
+  output: {
+     reportCodeType: { noModuleSource: true } // { noAssetsAndModuleSource: true }
+  }
 }),
 ```
 

package/docs/zh/guide/start/action.mdx

@@ -58,9 +58,12 @@ export default defineConfig({
 target_branch: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
 ```
 
-- `on` 是指 workflow 运行的时机，通常设置为 `pull_request` 和 `push`。
+- `dispatch_target_branch`：非必需，用于手动触发 (workflow_dispatch) 时指定目标分支。
+
+- `on` 是指 workflow 运行的时机，通常设置为 `pull_request` 和 `push`，也支持 `workflow_dispatch` 手动触发。
   - 在 `pull_request` 时，Rsdoctor Action 会拉取 baseline 和 current，进行 bundle diff 分析。
   - 在 `push`（即 PR 合并）时，会进行 baseline 的更新和上传操作。
+  - `workflow_dispatch` 允许在 GitHub Actions 页面手动触发工作流。此模式结合了 `push` 和 `pull_request` 的行为：会上传 baseline 数据，同时如果指定了 `dispatch_target_branch`，还会进行 baseline 对比分析。
 - 在执行 rsdoctor-action 之前，需要先将项目进行构建，构建时需要开启 Rsdoctor 插件，并生成 Rsdoctor JSON 数据文件。
 
 ```yaml
@@ -72,6 +75,13 @@ on:
   push:
     branches:
       - main # 或者其他目标分支
+  workflow_dispatch: # 可选，允许手动触发
+    inputs:
+      target_branch:
+        description: '用于对比的目标分支'
+        required: false
+        default: 'main'
+        type: string
 
 jobs:
   bundle-analysis:
@@ -115,6 +125,8 @@ jobs:
           # 默认 'main'，如果想用不固定的目标分支，即自动获取当前 pull request 的 target branch，则可以使用下方配置：
           # ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
           target_branch: 'main'
+          # 手动触发时使用的目标分支
+          dispatch_target_branch: ${{ github.event.inputs.target_branch }}
 ```
 
 ## 查看报告

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdoctor/docs",
-  "version": "1.4.1-beta.0",
+  "version": "1.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -33,7 +33,7 @@
     "rspress-plugin-sitemap": "^1.2.1",
     "typescript": "^5.9.2",
     "@rsbuild/plugin-sass": "^1.4.0",
-    "@rsdoctor/types": "1.4.1-beta.0"
+    "@rsdoctor/types": "1.5.0"
   },
   "dependencies": {
     "@rstack-dev/doc-ui": "1.12.2",