ヒント
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をインストールまたは承認する権限が必要です。
-
-
-
Classic トークン
repoスコープが必要です(パブリックリポジトリと同期する場合は
public_repo) -
Fine-grained トークン
以下の権限が必要です:
-
Contents: 読み取りおよび書き込み
-
Pull requests: 読み取りおよび書き込み
-
-
リポジトリ設定で署名付きコミットが不要であることを確認してください。
-
-
GitHub で SSO が有効になっている場合は、アクセストークンも有効にする必要があります。
-
phrase_translations ブランチは保護できません。
設定ファイルが配置されたら、リポジトリを接続するために以下の手順に従ってください:
-
ページから、までスクロールダウンし、Configureをクリックします。
ページが開きます。
-
Add Sync/GitHubをクリックします。
設定ウィンドウが開きます。
-
ドロップダウン一覧からプロジェクトを選択します。
-
認証方法を選択します:
-
GitHub Appがまだインストールされていない場合は、Authenticateをクリックします。認証は一度実行されれば、複数のリポジトリ同期で再利用できます。
GitHub Appが既にインストールされている場合は、Manage installationをクリックして、ターゲット組織またはアカウントのアプリインストールを完了します。リポジトリアクセスは組織またはアカウントレベルで管理され、個々のGitHubユーザーには紐付けられません。
-
個人用アクセストークンを使用する場合、リポジトリアクセスはトークンを作成したGitHubユーザーに依存します。
-
-
-
ドロップダウン一覧からを選択します。
-
インポート(プッシュ)およびエクスポート(プル)を行うをドロップダウン一覧から選択します。通常はmasterブランチです。
-
オプションで、プルリクエスト用のブランチ名を提供します。空欄のままにした場合、デフォルト値でブランチが作成されます。
-
Validate Configurationをクリックして、認証設定と設定ファイルが正しいことを確認します。
-
必要に応じて オプションを選択し、新規または更新されたファイルがプロジェクトに自動的にインポートされるタイミングを決定します。
-
保存をクリックします。
プロジェクトが選択したGitHubリポジトリに接続され、一覧に追加されました。
-
(オプション)鉛筆アイコンをクリックして、統合機能の名前を変更します。
.phrase.yml 設定ファイル内で、プッシュコマンドが正しく設定されていることを確認してください。プッシュオプションは、アップロード API エンドポイントと同じです。
ファイルをインポートするには:
-
ページから、プロジェクトを選択して インポート
をクリックします。
言語ファイル(設定ファイルの原文エントリとして定義)がプロジェクトにインポートされます。
デフォルトのロケールが存在している必要があります。
備考
インポート時に問題が発生した場合は、CLI クライアントを使用して
.phrase.yml設定ファイルをローカルでテストし、エラーメッセージを確認してください。必要な場合は、Phraseテクニカルサポートに連絡<1>}し、サポートリクエストに
.phrase.yml設定ファイルを添付してください。
.phrase.yml 設定ファイル内で、プルコマンドが正しく設定されていることを確認してください。プルオプション(例:include_empty_translations パラメータ)は、ロケール ダウンロード API エンドポイントと同じです。
ファイルをエクスポートするには:
-
ページから、プロジェクトを選択して エクスポート
をクリックします。
ウィンドウが表示されます。
-
フィールドに、対象のブランチを入力します。
リポジトリ内の最新ファイルが、新しいプルリクエストとして目的のブランチにエクスポートされます。
-
ファイルがエクスポートされたら、リポジトリでプルリクエストを結合またはクローズし、ブランチを削除できます。
備考
エクスポート時に問題が発生した場合は、CLIクライアントを使用して.phrase.yml設定ファイルをローカルでテストし、エラーメッセージを確認してください。
必要な場合は、Phraseテクニカルサポートに連絡<1>}し、サポートリクエストに .phrase.yml 設定ファイルを添付してください。