GitHub Action、GitLab CI/CD、Bitbucket Pipelines、またはスタンドアロン CLI 向けに継続的ローカライゼーションをセットアップできます。いずれもパイプライン内で Lingo.dev CLI を実行するため、手順は共通です。CLI を設定し、API キーを追加し、ワークフローを選ぶ、という 3 ステップで進められます。
GitHub App をセットアップする場合
GitHub App ではこの手順は使いません。ローカル CLI も、i18n.json も、API キーのシークレットも不要です。アプリを一度インストールして、リポジトリに .lingo/config.json を追加するだけです。代わりに GitHub App ガイド をご覧ください。
前提条件
CI/CD を追加する前に、CLI セットアップ を完了し、i18n.json ファイルがあり、ローカルで npx lingo.dev@latest run を実行できる状態である必要があります。
ステップ 1. CLI を設定する#
まだの場合は、CLI セットアップ ガイドに従ってください。完了時点で、次の状態になっているはずです。
- プロジェクトのルートに
i18n.jsonファイルがある - API キーがある（Lingo.dev エンジン用の
LINGO_API_KEY、またはOPENAI_API_KEYのようなプロバイダーキー） npx lingo.dev@latest runでローカルの翻訳生成を実行できる
ステップ 2. API キーを CI シークレットとして追加する#
API キーは、利用している CI プラットフォームのシークレット管理に保存します。
- Settings > Secrets and variables > Actions に移動します
- New repository secret をクリックします
- 名前:
LINGODOTDEV_API_KEY、値: API キー - Add secret をクリックします
ステップ 3. ワークフローを選び、設定を追加する#
チームに合ったワークフローを選んだら、各プラットフォーム向けのガイドに進んでください。
| ワークフロー | おすすめのケース |
|---|---|
| main への commit | 手間なく、気づかないうちに翻訳更新を進めたい小規模チーム |
| main からの PR | 翻訳を main に反映する前にレビューしたいチーム |
| feature branch への commit | 長期間維持する feature branch があるチーム |
| feature branch からの PR | 翻訳の変更を 1 つひとつ細かく管理したいチーム |
どれを選べばよいか迷ったら、まずは "main への commit" から始めるのがおすすめです。いちばんシンプルで、あとからでも i18n.json を変えずに切り替えられます。
プラットフォーム別のセットアップ手順やワークフロー例は、以下をご覧ください。
セットアップを確認する#
CI ワークフローを設定したら、変更を push して動作を確認しましょう。連携が正しく設定されていれば、次のことが行われるはずです。
- 翻訳パイプラインを実行する
- 翻訳を commit する、または PR を作成する（ワークフローによって異なります）
i18n.lockファイルを更新する
CI で新しい翻訳を生成せず、翻訳が完了しているかだけを確認したい場合は、--frozen フラグを使います。
npx lingo.dev@latest run --frozen未翻訳のコンテンツが 1 つでもあると、非ゼロのステータスで終了します。デプロイ前のチェックとして便利です。例については 高度なパターン を参照してください。
