CI 构建与分发

部署、构建与分发

最短部署路径

要部署自己的 Gins-Rime 站，先跑这四步：

cd workers/gins-rime
nvm use
pnpm install
pnpm --dir site install
pnpm run deploy:full

这条命令会同时完成：

1. 构建 Astro 6 + Starlight 文档站
2. 部署 Cloudflare Worker API 与静态资产

当前工具链

• Node.js 25.9.0+
• pnpm 10.33+
• Wrangler 4.82+
• TypeScript 5.9+
• Astro 6.1+
• Starlight 0.38+

常用命令

workers/gins-rime/package.json 提供的常用命令：

pnpm run check
pnpm run build
pnpm run site:dev
pnpm run site:preview
pnpm run deploy
pnpm run deploy:full

• pnpm run check: 检查 Worker TypeScript + Astro/Starlight 站点
• pnpm run build: 构建文档站
• pnpm run site:dev: 本地启动 Astro 文档站
• pnpm run deploy: 只部署 Worker
• pnpm run deploy:full: 先构建文档站，再部署 Worker

Cloudflare 侧资源

workers/gins-rime/wrangler.jsonc 里会用到这些资源：

• R2: 词库与发布产物
• Workers Assets: 文档站静态产物
• Queues: 构建通知
• Workflows: DictUpdateWorkflow

部署前先确认：

1. r2_buckets 已指向你的 bucket
2. queues 已创建
3. workflows 可用
4. 自定义域名或 route 已配置
5. WORKER_API_TOKEN 已设置为 Worker secret，用于保护 Worker 内部写接口
6. GitHub Actions 仓库 secret CF_API_TOKEN 已配置，用于发布到 Cloudflare R2

设置 Worker secret：

wrangler secret put WORKER_API_TOKEN

设置 GitHub Actions secret：

• 名称：CF_API_TOKEN
• 用途：让 release.yml、build-tone-moe.yml、build-shici.yml、build-zhwiki.yml 能上传 R2 对象

如果你是 fork 后自部署：

• 文档站里的下载链接已经使用相对路径，不需要改页面代码
• 本地脚本和 Swift CLI 如需指向你自己的 Worker，可设置环境变量 GINS_RIME_WORKER

例如：

export GINS_RIME_WORKER="https://your-rime.example.com"
./tools/gins-rime update

词库构建链路

zhwiki

流程：

1. 下载 zhwiki-latest-all-titles-in-ns0.gz
2. zhwiki-builder 过滤与转换标题
3. 生成 zhwiki.dict.yaml
4. 上传到 R2
5. 触发 DictUpdateWorkflow

gins-shici

流程：

1. 拉取 chinese-poetry
2. shici-builder 去重、转简、生成拼音
3. 上传 gins-shici.dict.yaml 到 R2

分发路径

完整路径是：

GitHub Actions / Manual Build
  -> R2
  -> Worker /version + /dicts/*
  -> macOS gins-rime 脚本 / Swift CLI
  -> iOS Hamster 导入与同步

常见操作

cd workers/gins-rime
pnpm --dir site build

cd workers/gins-rime
pnpm run check

cd workers/gins-rime
pnpm run deploy:full

CI 依赖

Ubuntu 跑 Rust 词库构建时还需要 OpenCC：

- name: Install OpenCC
  run: sudo apt-get install -y libopencc-dev