統合機能

GitHub (Strings)

本コンテンツはPhrase Language AIの機械翻訳により、英語から翻訳されています。

ヒント

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 組織またはアカウントにインストールされている必要があります。

    • リポジトリはOAuth Appのインストールに含まれている必要があります。

    • 訳文の組織またはアカウントでGitHub Appsをインストールまたは承認する権限が必要です。

  • GitHub アクセス トークン:

    • Classic トークン

      repoスコープが必要です(パブリックリポジトリと同期する場合はpublic_repo

    • Fine-grained トークン

      以下の権限が必要です:

      • Contents: 読み取りおよび書き込み

      • Pull requests: 読み取りおよび書き込み

    • リポジトリ設定で署名付きコミットが不要であることを確認してください。

  • GitHub で SSO が有効になっている場合は、アクセストークンも有効にする必要があります。

  • phrase_translations ブランチは保護できません。

備考

継続的な改善が行われているため、ユーザーインターフェイスは動画で紹介されているものと完全に同じではない可能性があります。

リポジトリを接続する

設定ファイルが配置されたら、リポジトリを接続するために以下の手順に従ってください:

  1. Integrationsページから、Repo Syncまでスクロールダウンし、Configureをクリックします。

    Repo Syncsページが開きます。

  2. Add Sync/GitHubをクリックします。

    GitHub sync設定ウィンドウが開きます。

  3. ドロップダウン一覧からプロジェクトを選択します。

  4. 認証方法を選択します:

    • GitHub App (recommended)

      GitHub Appがまだインストールされていない場合は、Authenticateをクリックします。認証は一度実行されれば、複数のリポジトリ同期で再利用できます。

      GitHub Appが既にインストールされている場合は、Manage installationをクリックして、ターゲット組織またはアカウントのアプリインストールを完了します。リポジトリアクセスは組織またはアカウントレベルで管理され、個々のGitHubユーザーには紐付けられません。

    • 個人用アクセストークン

      APIスコープを持つ個人用リポジトリアクセストークンを提供します。

      個人用アクセストークンを使用する場合、リポジトリアクセスはトークンを作成したGitHubユーザーに依存します。

    • 自分でホストしているインスタンス

      GitHubのセルフホスト型APIエンドポイントと、APIスコープを持つ個人用リポジトリアクセストークンを提供します。

  5. ドロップダウン一覧からGitHubリポジトリを選択します。

  6. インポート(プッシュ)およびエクスポート(プル)を行うリポジトリブランチをドロップダウン一覧から選択します。通常はmasterブランチです。

  7. オプションで、プルリクエスト用のブランチ名を提供します。空欄のままにした場合、デフォルト値phrase-translationsでブランチが作成されます。

  8. Validate Configurationをクリックして、認証設定と設定ファイルが正しいことを確認します。

  9. 必要に応じて インポート オプションを選択し、新規または更新されたファイルがプロジェクトに自動的にインポートされるタイミングを決定します。

  10. 保存をクリックします。

    プロジェクトが選択したGitHubリポジトリに接続され、一覧に追加されました。

  11. (オプション)鉛筆アイコンをクリックして、統合機能の名前を変更します。

インポート ファイル

.phrase.yml 設定ファイル内で、プッシュコマンドが正しく設定されていることを確認してください。プッシュオプションは、アップロード API エンドポイントと同じです。

ファイルをインポートするには:

エクスポート ファイル

.phrase.yml 設定ファイル内で、プルコマンドが正しく設定されていることを確認してください。プルオプション(例:include_empty_translations パラメータ)は、ロケール ダウンロード API エンドポイントと同じです。

ファイルをエクスポートするには:

  1. リポジトリ同期ページから、プロジェクトを選択して エクスポート Sync Export をクリックします。

    エクスポートウィンドウが表示されます。

  2. PRブランチフィールドに、対象のブランチを入力します。

    リポジトリ内の最新ファイルが、新しいプルリクエストとして目的のブランチにエクスポートされます。

  3. ファイルがエクスポートされたら、リポジトリでプルリクエストを結合またはクローズし、ブランチを削除できます。

備考

エクスポート時に問題が発生した場合は、CLIクライアントを使用して.phrase.yml設定ファイルをローカルでテストし、エラーメッセージを確認してください。

必要な場合は、Phraseテクニカルサポートに連絡<1>}し、サポートリクエストに .phrase.yml 設定ファイルを添付してください。

履歴

リポジトリ同期は、各Phrase Stringsプロジェクトの最新のインポートおよびエクスポートの履歴を保持します。

履歴を表示するには:

  • Repo Syncsページから、プロジェクトを選択し、History Sync Historyをクリックします。

    プロジェクトのインポートおよびエクスポート履歴が表示されます。履歴内のエクスポートエントリには、対応する結合リクエストへのリンクが含まれています。

この記事は役に立ちましたか?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.