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