ci: 在 PR 评论中添加 API 文档预览链接 by RSS1102 · Pull Request #13 · TDesignOteam/tdesign-flutter-tools

RSS1102 · 2026-05-13T02:28:20Z

更新 preview-publish.yml，在 PR 评论中显示预览地址和 API 文档链接
重命名 workflow 文件 test-in-tdesign-flutter.yml -> pull-request.yml

- 更新 preview-publish.yml，在 PR 评论中显示预览地址和 API 文档链接 - 重命名 workflow 文件 test-in-tdesign-flutter.yml -> pull-request.yml

github-actions · 2026-05-13T02:31:53Z

✅ 编译完成，产物如下：

github-actions · 2026-05-13T02:36:23Z

Copilot

Pull request overview

该 PR 主要围绕 PR 预览构建/发布链路做拆分与增强：在构建阶段产出预览站点 artifact，并在后续 workflow_run 阶段更新 PR 评论；同时新增一个 CLI 子命令用于生成“文档变更 diff”的 Markdown 评论内容。

Changes:

新增 doc-diff CLI 子命令与实现：从 git 工作区变更中提取文档相关 diff，并生成可直接用于 PR 评论的 Markdown。
重构/重命名 PR 构建工作流：新增 pull-request.yml 承担构建与产物上传，preview-publish.yml 专注部署并更新预览评论，另新增 doc-diff-comment.yml 单独发布文档 diff 评论。
移除原有的预览构建 workflow（test-in-tdesign-flutter.yml）以及多平台二进制构建/校验 workflow（build-multi-platform.yml 与校验脚本）。

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
lib/doc_diff_comment.dart	新增：基于 git diff/status 生成文档变更 diff 的 Markdown（用于 PR 评论）。
bin/main.dart	新增命令 `doc-diff`，调用 `DocDiffComment` 输出 Markdown 文件。
.github/workflows/test-in-tdesign-flutter.yml	删除：旧的 PREVIEW_BUILD 工作流。
.github/workflows/pull-request.yml	新增：PR 构建 workflow，生成站点/示例与文档 diff，并上传 artifacts。
.github/workflows/preview-publish.yml	更新：基于 workflow_run 下载 artifacts、部署 Surge 并维护 PR 预览评论。
.github/workflows/doc-diff-comment.yml	新增：基于 workflow_run 下载文档 diff artifact，并单独维护 PR 文档 diff 评论。
.github/workflows/build-multi-platform.yml	删除：旧的多平台二进制构建与评论 workflow。
.github/scripts/cross_platform_verify.dart	删除：旧的跨平台二进制校验脚本。

Comments suppressed due to low confidence (2)

.github/workflows/preview-publish.yml:87

GitHub Actions 的 job id 需要使用 ASCII（[A-Za-z0-9_-]）格式；这里使用了中文 job id（构建失败通知），会导致 workflow 校验失败无法运行。建议把 key 改为英文 job id，并将中文放到 job 的 name: 字段。

  构建失败通知:
    runs-on: ubuntu-latest
    if: >
      github.event.workflow_run.event == 'pull_request' &&

.github/workflows/doc-diff-comment.yml:55

GitHub Actions 的 job id 需要使用 ASCII（[A-Za-z0-9_-]）格式；这里使用了中文 job id（构建失败通知），会导致 workflow 校验失败无法运行。建议把 key 改为英文 job id，并将中文放到 job 的 name: 字段。

  构建失败通知:
    runs-on: ubuntu-latest
    if: >
      github.event.workflow_run.event == 'pull_request' &&

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+  bool _match(String rel) {
+    final name = rel.split(Platform.pathSeparator).last;
+    return name.endsWith('_api.md') || name == 'README.md';
+  }


+  Future<String> _diff(String rel) async {
+    final git = ['-C', repoRoot];
+    final tracked = await Process.run('git', [...git, 'ls-files', '--error-unmatch', rel]);
+    if (tracked.exitCode == 0) {
+      final r = await Process.run('git', [...git, 'diff', '--no-color', '-U3', '--', rel]);
+      return '${r.stdout}'.trimRight().isEmpty ? '(无变更内容)' : '${r.stdout}'.trimRight();
+    }
+    final full = '${Directory(repoRoot).path}${Platform.pathSeparator}$rel';
+    final r = await Process.run('diff', ['-u', '/dev/null', full]);
+    return '${r.stdout}'.trimRight().isEmpty ? '(新文件)' : '${r.stdout}'.trimRight();
+  }


+      - name: dart analyze
+        run: dart analyze --fatal-infos
+
+  构建文档与预览站:


+permissions:
+  pull-requests: write
+
 jobs:
-  preview-success-web:
+  部署预览并评论:
    runs-on: ubuntu-latest
    if: >
      github.event.workflow_run.event == 'pull_request' &&
      github.event.workflow_run.conclusion == 'success'
    steps:
-      - name: download build artifacts
-        uses: dawidd6/action-download-artifact@v6
+      - name: 下载 PR 元数据
+        uses: actions/download-artifact@v4
        with:
-          workflow: ${{ github.event.workflow_run.workflow_id }}
-          run_id: ${{ github.event.workflow_run.id }}
-          name: build-env
+          name: pr-metadata
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}


 jobs:
-  preview-success-web:
+  部署预览并评论:
    runs-on: ubuntu-latest
    if: >


+      - name: 组装 PR 预览评论正文
+        env:
+          PREVIEW_URL: ${{ steps.deploy.outputs.url }}
+        run: |
+          {
+            printf '%s\n' \
+              "<a href=\"${PREVIEW_URL}\"><img height=\"96\" alt=\"完成\" src=\"https://user-images.githubusercontent.com/15634204/150816437-9f5bb788-cd67-4cbc-9897-b82d74e9aa65.png\" /></a>" \
+              '' \
+              "**预览地址**: [${PREVIEW_URL}](${PREVIEW_URL})" \
+              '' \
+              '<!-- AUTO_PREVIEW_HOOK -->'
+          } > pr-comment.md


+permissions:
+  pull-requests: write
+
+jobs:
+  发布文档-diff评论:
+    runs-on: ubuntu-latest
+    if: >
+      github.event.workflow_run.event == 'pull_request' &&
+      github.event.workflow_run.conclusion == 'success'
+    steps:
+      - name: 下载 PR 元数据
+        uses: actions/download-artifact@v4
+        with:
+          name: pr-metadata
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}


+jobs:
+  发布文档-diff评论:
+    runs-on: ubuntu-latest
+    if: >


github-actions · 2026-05-22T10:09:21Z

✅ 编译完成，产物如下：

api_tool_macos_intel（job: build-macos-intel）
api_tool_macos_arm64（job: build-macos-arm64）
api_tool_linux（job: build-linux-x64）
api_tool_windows（job: build-windows-x64）

在 Actions 运行页 Artifacts 区域按平台名称下载。

feat: 在 PR 评论中添加 API 文档预览链接

63d729e

- 更新 preview-publish.yml，在 PR 评论中显示预览地址和 API 文档链接 - 重命名 workflow 文件 test-in-tdesign-flutter.yml -> pull-request.yml

RSS1102 and others added 12 commits May 13, 2026 10:38

ci: 优化API文档生成流程并移除多余部署步骤

b60ebfb

ci: 修复工作流路径引用与base标签

1e7a7fa

ci: 移除多余的工作区路径变量引用

dc2ab05

ci: 编译dart CLI工具替代dart run执行

bfb7397

ci: 优化API文档生成流程及修复dart-sdk路径解析

fc5d33d

chore(ci): 移除 API 文档生成及简化 dart-sdk 查找逻辑

dfc44df

ci: 重构PR工作流以测试当前PR改动

0d830e1

ci: 简化预览工作流并改用标准 Actions

5db336b

ci: 优化预览发布与PR工作流

c6ac2c0

feat: 添加文档差异生成脚本并移除旧的验证脚本和工作流

bb6a59c

ci: 替换 maintain-one-comment 为内部 action

1aaadcb

feat: 移除旧的文档差异生成脚本并引入新的实现，更新工作流以支持新的文档差异评论功能

47578f7

RSS1102 requested a review from Copilot May 22, 2026 08:44

Copilot started reviewing on behalf of RSS1102 May 22, 2026 08:45 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

RSS1102 added 3 commits May 22, 2026 17:12

feat: 添加跨平台验证脚本和多平台构建工作流，移除旧的文档差异评论工作流

3c35610

chore: 移除独立静态分析工作流，并将静态分析步骤整合到主PR构建工作流中

2f152d0

feat: 添加新的文档差异生成脚本和API重生脚本，更新工作流以支持新的文档评论功能

47693d8

RSS1102 merged commit f9098a8 into main May 22, 2026
6 checks passed

RSS1102 deleted the feat/pr-preview-docs branch May 22, 2026 10:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: 在 PR 评论中添加 API 文档预览链接#13

ci: 在 PR 评论中添加 API 文档预览链接#13
RSS1102 merged 16 commits into
mainfrom
feat/pr-preview-docs

RSS1102 commented May 13, 2026

Uh oh!

github-actions Bot commented May 13, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 13, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

RSS1102 commented May 13, 2026

Uh oh!

github-actions Bot commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented May 13, 2026 •

edited

Loading

github-actions Bot commented May 13, 2026 •

edited

Loading