为 GitHub Action、GitLab CI/CD、Bitbucket Pipelines 或独立 CLI 搭建持续本地化。这些方案都会在你的流水线中运行 Lingo.dev CLI,因此配置步骤完全一致,都是 3 步:配置 CLI、添加 API 密钥,以及选择工作流。
想改用 GitHub App?
GitHub App 不走这套流程——不需要本地 CLI、i18n.json,也不需要 API 密钥 secret。你只需安装一次应用,并向仓库添加 .lingo/config.json。请直接参考 GitHub App 指南。
前提条件
在接入 CI/CD 之前,你需要先完成可用的 CLI 设置:包含 i18n.json 文件,并且能够在本地运行 npx lingo.dev@latest run。
第 1 步:配置 CLI#
如果你还没完成这一步,请先参考 CLI 设置指南。完成后,你应该具备:
- 项目根目录下有一个
i18n.json文件 - 一个 API 密钥(Lingo.dev Engine 使用
LINGO_API_KEY,或提供商密钥,例如OPENAI_API_KEY) - 能够通过
npx lingo.dev@latest run在本地生成翻译
第 2 步:将 API 密钥添加为 CI secret#
将你的 API 密钥保存在 CI 平台的 secret 管理中:
- 进入 Settings > Secrets and variables > Actions
- 点击 New repository secret
- 名称:
LINGODOTDEV_API_KEY,值:你的 API 密钥 - 点击 Add secret
第 3 步:选择工作流并添加配置#
选择最适合团队的工作流,然后按照对应平台的指南完成配置:
| 工作流 | 适用场景 |
|---|---|
| 提交到 main | 适合希望以零摩擦、无感更新翻译的小团队 |
| 从 main 发起 PR | 适合希望在翻译合入 main 前先进行审核的团队 |
| 提交到功能分支 | 适合拥有长期功能分支的团队 |
| 从功能分支发起 PR | 适合希望对每一次翻译变更都保持最高控制力的团队 |
不确定选哪个?先从“提交到 main”开始——这是最简单的方式。之后你也可以随时切换,而且无需修改 i18n.json。
各平台的详细配置说明和工作流示例见:
GitHub Actions
官方 GitHub Action,附带工作流示例
GitLab CI/CD
Docker 镜像,附带流水线示例
Bitbucket Pipelines
官方 Pipe,附带工作流示例
验证设置#
配置好 CI 工作流后,推送一次变更来触发它。集成应会:
- 运行翻译流水线
- 提交翻译或创建 PR(取决于你选择的工作流)
- 更新
i18n.lock文件
如果你想在 CI 中验证翻译是否完整、但不生成新的翻译,可以使用 --frozen 标志:
bash
npx lingo.dev@latest run --frozen如果有任何内容尚未翻译完成,该命令会以非零状态退出——很适合作为部署门禁。示例请参阅 高级模式。
