@rsdoctor/docs 1.3.7 → 1.3.9

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

@@ -52,14 +52,23 @@ export default defineConfig({
 Create a `.github/workflows/ci.yml` file in your GitHub repository as shown in the example below. Please note the following points:
 
 - `file_path`: Required, path to the Rsdoctor JSON data file.
-- `target_branch`: Optional, target branch name, defaults to 'main'.
-- `on` refers to the timing of execution. It needs to run on both `pull_request` and `push`. During `pull_request`, Rsdoctor Action will pull baseline and current data for bundle diff analysis. During `push` (i.e., when PR is merged), it will perform baseline update and upload operations.
-- Before executing rsdoctor-action, you need to build the project first. During the build process, you need to enable the Rsdoctor plugin and generate the Rsdoctor JSON data file.
+- `target_branch`: Optional, target branch name, defaults to '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:
+
+```yaml
+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`.
+  - 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.
+- Before executing rsdoctor-action, build your project with the Rsdoctor plugin enabled to generate the Rsdoctor JSON data file.
 
 ```yaml
 name: Bundle Analysis
 
-on: [pull_request, push]
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
 
 jobs:
   bundle-analysis:
@@ -100,16 +109,11 @@ jobs:
         uses: web-infra-dev/rsdoctor-action@main
         with:
           file_path: 'dist/.rsdoctor/rsdoctor-data.json'
-          target_branch: ${{ github.ref_name }}
+          # 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'
 ```
 
-#### Configuration Options
-
-In the above configuration:
-
-- `file_path`: Required, path to the Rsdoctor JSON data file.
-- `target_branch`: Optional, target branch name, defaults to 'main'.
-
 ## View Reports
 
 After submitting the above configuration file to your repository, GitHub Actions will automatically run under the specified trigger conditions and generate Rsdoctor analysis reports. You will see bundle size change comparison prompts in GitHub CI, as shown below:

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

@@ -52,7 +52,12 @@ export default defineConfig({
 在你的 GitHub 仓库中创建 `.github/workflows/ci.yml` 文件，如下示例。需要注意以下几点：
 
 - `file_path`：必需，Rsdoctor JSON 数据文件路径。
-- `target_branch`：非必需，目标分支名称，默认是 'main'。
+- `target_branch`：非必需，目标分支名称，默认是 'main'。如果想用不固定的目标分支，即自动获取当前 pull request 的 target branch，而不是固定的主分支，则可以使用下方配置：
+
+```yaml
+target_branch: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
+```
+
 - `on` 是指 workflow 运行的时机，通常设置为 `pull_request` 和 `push`。
   - 在 `pull_request` 时，Rsdoctor Action 会拉取 baseline 和 current，进行 bundle diff 分析。
   - 在 `push`（即 PR 合并）时，会进行 baseline 的更新和上传操作。
@@ -61,7 +66,9 @@ export default defineConfig({
 ```yaml
 name: Bundle Analysis
 
-on: [pull_request, push]
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
 
 jobs:
   bundle-analysis:
@@ -102,7 +109,9 @@ jobs:
         uses: web-infra-dev/rsdoctor-action@main
         with:
           file_path: 'dist/.rsdoctor/rsdoctor-data.json'
-          target_branch: ${{ github.ref_name }}
+          # 默认 'main'，如果想用不固定的目标分支，即自动获取当前 pull request 的 target branch，则可以使用下方配置：
+          # ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref || github.event.repository.default_branch }}
+          target_branch: 'main'
 ```
 
 ## 查看报告

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdoctor/docs",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -18,8 +18,8 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@rspress/plugin-algolia": "2.0.0-beta.34",
-    "@rspress/plugin-llms": "2.0.0-beta.34",
+    "@rspress/plugin-algolia": "2.0.0-beta.35",
+    "@rspress/plugin-llms": "2.0.0-beta.35",
     "@rspress/plugin-rss": "2.0.0-beta.29",
     "@types/node": "^22.8.1",
     "@types/react": "^18.3.26",
@@ -33,13 +33,13 @@
     "rspress-plugin-sitemap": "^1.2.1",
     "typescript": "^5.9.2",
     "@rsbuild/plugin-sass": "^1.4.0",
-    "@rsdoctor/types": "1.3.7"
+    "@rsdoctor/types": "1.3.9"
   },
   "dependencies": {
     "@rstack-dev/doc-ui": "1.11.0",
     "clsx": "^2.1.1",
     "react-markdown": "^9.1.0",
-    "@rspress/core": "2.0.0-beta.34"
+    "@rspress/core": "2.0.0-beta.35"
   },
   "scripts": {
     "dev": "cross-env RSPRESS_PERSIST_CACHE=false rspress dev",