GitHub App

Locadex GitHub appは、リポジトリを監視し、変更をプッシュするたびに翻訳付きのプルリクエストにコミットすることで、コードベースを自動的に国際化します。

セットアップ手順

ステップ1: アカウントにサインイン

General Translation dashboardにアクセスし、アカウントにサインインしてください。ProおよびEnterpriseユーザーのみがGitHubアプリを使用できます。

ステップ2: GitHubを接続

  1. ダッシュボードのGitHub統合セクションに移動します
  2. 「Connect GitHub」をクリックしてGitHubアカウントをリンクします
  3. 接続を承認するためにGitHubにリダイレクトされます

ステップ3: GitHubアプリをインストール

  1. GitHubを接続した後、Locadex GitHubアプリをインストールするためにリダイレクトされます
  2. Locadexにアクセス権を与えるリポジトリを選択します:
    • すべてのリポジトリにインストール、または
    • 特定のリポジトリを選択
  3. 「Install」をクリックしてGitHubアプリのインストールを完了します

ステップ4: リポジトリをプロジェクトにリンク

  1. GTダッシュボードに戻り、国際化したいリポジトリを選択します
  2. これにより、リポジトリが翻訳設定とターゲット言語に接続されます
  3. 1つのプロジェクトにリンクできるリポジトリは1つだけですが、それぞれ異なるリポジトリを持つ複数のプロジェクトを作成できます

ステップ5: 設定を構成

設定画面で以下を設定します:

  • ターゲット言語: 翻訳先のロケールを選択
  • アプリディレクトリ: モノレポを使用している場合のディレクトリを指定(例:apps/web/
  • ブランチプレフィックス: Locadexが作成するブランチのプレフィックスをカスタマイズ(デフォルト:locadex/

ステップ6: インストールを完了

  1. 設定内容を確認します
  2. 「Install」をクリックしてリポジトリでLocadexを有効化します
  3. 接続されたGitHubリポジトリを表示する概要ページに移動します

次に何が起こるか

初期セットアップ

インストールを完了すると:

  1. 即座のPR作成: Locadexがメインブランチにプルリクエストを作成します
  2. 完全なセットアップ: このPRは完全なLocadexセットアップコマンドを実行し、以下を行います:
    • ライブラリのインストール
    • 国際化のためのプロジェクト設定
    • 翻訳インフラストラクチャのセットアップ
  3. レビューとマージ: PRをレビューしてマージし、i18nセットアップを完了します

継続的な運用

初期セットアップがマージされた後:

  1. Locadexはメインブランチまたは指定されたブランチのプルリクエストを監視します
  2. 翻訳可能なコンテンツを含む新しいコードをプッシュした際は、LocadexがPRにコミットを追加するまで待ちます
  3. LocadexがPRにコミットしたら、マージしても安全です -- 新しいコードは国際化されています
  4. アプリは手動での介入なしに翻訳された状態を維持します

リポジトリの監視

ダッシュボードステータス

GTダッシュボードでは、以下を監視できます:

  • リポジトリステータス: アクティブな監視インジケーター
  • 設定: 現在の設定とターゲット言語

GitHub統合

  • ステータスチェック: Locadexはプルリクエストにステータス更新を追加します
  • チェック実行: GitHubはLocadexの処理ステータスを表示します

トラブルシューティング

よくある問題

LocadexがPRを作成しない

  • GitHub appにリポジトリアクセス権限があることを確認してください
  • コミットに翻訳可能なコンテンツが含まれていることを確認してください

設定変更が必要

  • GTダッシュボードでブランチ設定を更新してください
  • 変更は更新後の新しいコミットに適用されます

Locadex GitHub appは現在オープンリサーチプレビュー中です。

関連項目

  • Locadex CLI - コマンドラインインターフェース

このガイドはいかがですか?