跳转到内容

CI 和 Pages

文档站点位于 docs/,使用 Starlight 和 pnpm。

Terminal window
cd docs
pnpm install
pnpm dev
pnpm build

本地预览路径包含 base path:

http://127.0.0.1:4321/xue_hua_webview

中文文档路径:

http://127.0.0.1:4321/xue_hua_webview/zh

.github/workflows/ci.yml 会在 pull request 和手动触发时运行。任务使用当前最低 支持的 Flutter 版本线,以及当前 3.44 稳定线。

workflow 会:

  • 在每条 Flutter 版本线上分析并测试所有 Dart 包,以及示例应用;
  • 在 Chrome 运行 Web 测试并构建 Web 示例;
  • 在两条 Flutter 版本线上运行 Android native unit test 并构建 APK;
  • 在两条 Flutter 版本线上编译 iOS、macOS 示例,并在最低版本线上编译 Linux、Windows 示例,从而在对应 runner 验证 native 插件代码。

workflow 文件是 .github/workflows/docs.yml。只有 docs/ 下文件发生变化并 push 到 main 时才会自动运行,也可以手动触发。

构建流程:

  1. checkout 代码。
  2. 安装 pnpm 10.19.0。
  3. 安装 Node 24,并启用 pnpm cache。
  4. docs/ 执行 pnpm install --frozen-lockfile
  5. 执行 pnpm build
  6. 上传 docs/dist
  7. 使用 GitHub Pages Actions 部署。

Astro 配置:

site: 'https://matkurban.github.io',
base: '/xue_hua_webview',

部署后地址:

https://matkurban.github.io/xue_hua_webview

中文地址:

https://matkurban.github.io/xue_hua_webview/zh

GitHub 仓库设置中 Pages source 需要选择 GitHub Actions