ヒント
Phrase TMSにおけるGitHub統合に関する情報は、GitHub (TMS)を参照してください。
Phrase Stringsは、PhraseとGitHubの間でローカリゼーションファイルを同期するためにGitHubリポジトリと統合されています。
デフォルトでは、リポジトリはGitHub OAuthアプリを使用して接続されます。個人用アクセストークンもサポートされており、主に自己ホスト型インスタンスやOAuthアプリのインストールが不可能な環境向けです。
前提条件
-
.phrase.yml設定ファイルは、監視対象のブランチのルートに存在する必要があります。ファイルは、リポジトリからインポート(pull)またはエクスポート(push)するファイルを定義します。 -
リポジトリには読み取りおよび書き込みアクセスが必要です。
-
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushとpull訳文、正しいファイル形式、および
update_translationsパラメータの設定があることを確認してください。 -
-
GitHub OAuthアプリは、リポジトリを所有するGitHub組織またはアカウントにインストールされている必要があります。
-
リポジトリはOAuthアプリのインストールに含まれている必要があります。
-
ターゲットの組織またはアカウントでGitHubアプリをインストールまたは承認するための権限が必要です。
-
-
-
クラシックトークン
リポジトリスコープが必要です(公開リポジトリと同期する場合は
public_repo) -
詳細なトークン
次の権限が必要です:
-
コンテンツ:読み取りと書き込み
-
プルリクエスト:読み取りと書き込み
-
-
リポジトリ設定で署名付きコミットが不要であることを確認してください。
-
-
GitHub で SSO が有効になっている場合は、アクセストークンも有効にする必要があります。
-
phrase_translations ブランチは保護できません。
設定ファイルが配置されたら、リポジトリを接続するために、次の手順に従ってください:
-
ページから、下にスクロールして を見つけ、設定 をクリックします。
ページが開きます。
-
同期/ GitHub を追加 をクリックします。
設定ウィンドウが開きます。
-
ドロップダウンリストからプロジェクトを選択します。
-
認証方法を選択してください:
-
GitHub アプリがまだインストールされていない場合は、認証 をクリックします。認証は一度行われ、複数のリポジトリ同期に再利用できます。
GitHub アプリがすでにインストールされている場合は、インストールを管理 をクリックして、ターゲット組織またはアカウントのアプリインストールを完了します。リポジトリへのアクセスは、組織またはアカウントレベルで管理されており、個々のGitHubユーザーに結びついていません。
-
個人用アクセストークンを使用する場合、リポジトリへのアクセスはトークンを作成したGitHubユーザーに依存します。
-
-
-
ドロップダウンリストからを選択してください。
-
ドロップダウンリストからを選択して、インポート(プッシュ)およびエクスポート(プル)します。通常、これはマスターブランチです。
-
オプションで、プルリクエストのためのブランチ名を提供してください。空欄のままにすると、デフォルト値でブランチが作成されます。
-
設定の検証をクリックして、認証設定と構成ファイルが正しいことを確認してください。
-
オプションで、プロジェクトに新しいまたは更新されたファイルが自動的にインポートされるタイミングを決定するためのオプションを選択してください。
-
保存をクリックします。
プロジェクトは選択したGitHubリポジトリに接続され、リストに追加されました。
プッシュコマンドが.phrase.ymlの構成ファイル内で正しく設定されていることを確認してください。プッシュオプションはアップロードAPIエンドポイントと同じです。
ファイルをインポートするには:
-
ページからプロジェクトを選択し、インポート
をクリックします。
言語ファイル(設定ファイル内のプッシュソースエントリとして定義される)はプロジェクトにインポートされます。
デフォルトのロケールが存在する必要があります。
備考
インポート時に問題が発生した場合は、CLIクライアントを使用して、
.phrase.yml設定ファイルをローカルでテストし、エラーメッセージを確認してください。必要に応じて、Phraseテクニカルサポートに連絡し、サポートリクエストに
.phrase.yml設定ファイルを添付してください。
プルコマンドが.phrase.yml 設定ファイル内で正しく構成されていることを確認してください。プルオプション(例:include_empty_translationsパラメータ)は、ロケールのダウンロード APIエンドポイントと同じです。
ファイルをエクスポートするには:
-
ページから、プロジェクトを選択し、エクスポート
をクリックします。
ウィンドウが表示されます。
-
フィールドにターゲットブランチを指定してください。
リポジトリ内の最新のファイルが、希望するブランチへの新しいプルリクエストとしてエクスポートされます。
-
ファイルがエクスポートされると、プルリクエストはリポジトリ内でマージまたはクローズされ、ブランチは削除できます。
備考
エクスポート時に問題が発生した場合は、CLIクライアントを使用して、.phrase.yml設定ファイルをローカルでテストし、エラーメッセージを確認してください。
必要に応じて、Phraseテクニカルサポートに連絡し、サポートリクエストに.phrase.yml設定ファイルを添付してください。