GitHub インテグレーション
Git リポジトリは、大多数のソフトウェアプロジェクトの中核です。Tuist は GitHub とインテグレートし、プルリクエスト内で Tuist のインサイトを提供するとともに、デフォルトブランチの同期などの設定の手間を省きます。
セットアップ#
組織の Integrations タブで Tuist GitHub アプリをインストールする必要があります: 
GitHub から直接アプリをインストールすることもできます。必要に応じて Tuist にログインし、GitHub App を承認して Tuist がインストールへのアクセス権を確認できるようにし、接続する Tuist 組織を選択してください。アプリをインストールする GitHub 組織(または個人用 GitHub アカウント)の所有者である必要があります。選択できるのは、あなたが管理する Tuist 組織とあなたの個人用 Tuist アカウントのみです。アプリが個人用 GitHub アカウントにインストールされ、個人用 Tuist アカウントしか選択肢がない場合のみ、Tuist は選択画面を省略します。GitHub 組織の場合、個人用アカウントしか選択肢であっても、Tuist は常に確認を行います。チームの Tuist 組織が一覧に表示されない場合は、組織を作成を選択するか、その組織の管理者の一人にあなたを管理者として追加するよう依頼してください。ページを開いている間はリストが更新されるため、Tuist に戻ってから10分以内に対象を選択すれば、やり直すことなく組織が表示されます。Tuist から開始した場合、組織はすでに選択されており、この手順は省略されます。
その後、GitHub リポジトリと Tuist プロジェクトの間にプロジェクト接続を追加できます:

アプリをインストールした後、ダッシュボードを使わずにプロジェクトをリンクすることもできます:
- CLI:
tuist project repository connect owner/name、およびリンクを削除するにはtuist project repository disconnect。 - REST API:
/api/projects/{account_handle}/{project_handle}/vcs-connectionに対するPUTおよびDELETE。 - Model Context Protocol:
connect_project_repositoryツールおよびdisconnect_project_repositoryツール。
リポジトリは GitHub App のインストールがアクセス可能なものでなければならず、プロジェクトはそのリポジトリのデフォルトブランチを採用します。アカウントトークンには project:admin:write スコープが必要です。
GitHub 組織が IP 許可リスト を使用している場合、または GitHub インスタンスがファイアウォールの背後にある場合は、インテグレーションがリポジトリと通信できるように、Tuist の 送信 IP アドレス をホワイトリストに登録してください。
GitHub Enterprise Server#
Tuist はセルフホスト型の GitHub Enterprise Server (GHES) インスタンスともインテグレートします。GitHub インテグレーションカードで Enterprise server タブに切り替え、GHES のベース URL(例: https://github.example.com)を入力し、インストールをクリックしてください。
GitHub Apps は単一の GitHub インスタンスにスコープされるため、Tuist は github.com 用の App を GHES で再利用できません。代わりに、インストールボタンをクリックすると GitHub の App マニフェストフロー が始まります。GHES は管理者をガイドしてインスタンス上に新しい Tuist App を登録し、新しく作成された App の認証情報を Tuist に返します。Tuist はこれらの認証情報をインストールごとに暗号化して保存し、以降のすべての API コール、Webhook 署名、およびリポジトリへのリンクで使用します。
追加の Tuist サーバー設定は不要です。マニフェストフローによってすべてが自動的に生成・プロビジョニングされます。
App の権限と Webhook イベント#
Tuist は PR コメントとバンドルサイズチェックのために、以下の リポジトリ権限 を必要とします:
| 権限 | アクセス | 用途 |
|---|---|---|
メタデータ (metadata) |
読み取り専用 | 基本的なリポジトリメタデータ。GitHub がすべての App に要求 |
プルリクエスト (pull_requests) |
読み取りと書き込み | プルリクエストの読み取り(ヘッドコミットの SHA を含む)、および PR コメントの一覧取得、投稿、更新 |
Checks (checks) |
読み取りと書き込み | チェックランの作成と更新(バンドルサイズの合格/不合格チェックを含む) |
Tuist は check_run Webhook イベントを使用してバンドルサイズチェックのアクションを処理します。マニフェストフローにより、このサブスクリプションは自動的に構成されます。
セルフホスト型の Tuist サーバーで github.com 上で手動で App を設定する場合は、セルフホスティングガイドを参照してください。
ブラウザ用 URL と API 用 URL の分離#
エンジニアが内部ホスト名を通じて GitHub Enterprise にアクセスし、サードパーティのサービスが外部プロキシを使用する場合、インストールをクリックする前に両方のアドレスを設定してください:
| フィールド | 例 | 使用者 |
|---|---|---|
| Server URL | https://github.internal.company.com |
ブラウザによる App の登録とインストール、および Tuist から GitHub へのリンク |
| API URL | https://github-proxy.company.com/api/v3 |
Tuist のサーバー。マニフェストコードの交換、アクセストークン、リポジトリアクセス、PR コメント、およびチェックに使用 |
API URL は、/api/v3 またはプロキシが公開する同等のパスを含む完全な REST API ベース URL です。Tuist は明示的な API URL に /api/v3 を追加しません。ブラウザと Tuist の両方で同じホスト名が機能する場合は空のままにしてください。既存の接続は引き続き <Server URL>/api/v3 を使用します。
両方のアドレスは 同じ GitHub Enterprise インスタンス にルーティングされる必要があります。ブラウザは Server URL に到達できればよく、API プロキシへの到達は不要です。Tuist のサーバーは API URL に到達できればよく、内部のブラウザ用ホスト名への到達は不要です。
外部プロキシの場合:
- Tuist のサーバーが信頼する証明書を使用し、パブリック IP アドレスに解決されるパブリック DNS を備えた HTTPS を使用してください。API URL のオーバーライドは、Tuist のプライベート IP/SSRF 保護を回避しません。オーバーライド先はあなたの Enterprise インスタンスであり、
github.comや*.github.comエンドポイントであってはなりません。 - Tuist のすべての 送信 IP アドレス を許可リストに登録してください。
- Tuist が使用する REST API エンドポイントを転送してください。
POST /api/v3/app-manifests/{code}/conversions、POST /api/v3/app/installations/{installation_id}/access_tokens、およびコメントやチェック用のリポジトリ API エンドポイントが含まれます。これらは GitHub のアップストリームパスです。プロキシが異なるプレフィックスを公開している場合は、それらに合わせて翻訳してください。 - HTTP リダイレクトやインタラクティブなサインインページなしで、GitHub へのリクエストを転送してください。Tuist は Enterprise API のリダイレクトを自動的に追従しないため、パブリック IP チェックをバイパスできません。マニフェスト変換エンドポイントは、Tuist が App の認証情報を取得する前のセットアップ中に到達可能である必要があります。GitHub Actions のログダウンロードは例外です。Tuist は署名付きアーカイブのリダイレクトを HTTPS 経由でのみ追従し、すべての宛先をパブリック IP にチェックして固定し、インストールトークンを転送しません。
GitHub は内部ホスト名を使用してページネーションリンクを返す場合があります。Tuist は、構成された GitHub インスタンスからのリンクを API URL に基づいて再ベース化し、プロキシのパスプレフィックスを保持します。無関係なオリジンへのリンクは拒否されます。
別途、GitHub は https://tuist.dev/webhooks/github(またはセルフホスト型の Tuist サーバー上の /webhooks/github)に Webhook を配信できる必要があります。エンジニアはブラウザのコールバックを完了するために Tuist に戻れる必要があります。API URL はどちらの宛先も変更しません。
組織管理者は、統合カード内の Save API URL を使用して、既存の Enterprise 統合の API URL を変更またはクリアすることもできます。App の再インストールやプロジェクトの再接続は不要です。クリアすると <Server URL>/api/v3 に復元されます。保存時には URL 形式のみが検証され、プロキシの接続性は検証されません。インストールルックアップはキャッシュされるため、Webhook 処理が変更後のアドレスを使用するまで最大 1 分かかる場合があります。すでに進行中のリクエストは、引き続き以前のアドレスを使用する可能性があります。
ホスト型 Tuist サーバー(https://tuist.dev)では、GitHub Enterprise Server 統合は Enterprise プランの組織のみ利用可能です。セルフホスト型の Tuist デプロイメントでは、どのプランでも使用できます。
プル/マージリクエストのコメント#
GitHub App は Tuist の実行レポートを投稿します。これには PR の概要が含まれ、最新の プレビュー や テスト へのリンクも含まれます:
Tuist は結果が届くにつれて 1 つのコメントを更新します。Gradle ビルドは、各ルートプロジェクトと要求されたタスクのセットごとに別々に表示されます。同じタスクを再実行すると、その呼び出しの以前の結果が置き換えられます。完全なビルド履歴は Tuist で引き続き利用可能です。
コメントはデフォルトで有効になっており、既存の統合に対するレポート機能が維持されます。プロジェクトに対してコメントをオフまたはオンにするには、Project Settings → Integrations を開き、GitHub → Run report comments を切り替えます。各プロジェクトには独自の設定があります。リポジトリ接続は組織設定で管理されます。
コメントを無効にしても、ビルドまたはテストのアップロード、GitHub Actions ジョブサマリー、リポジトリ接続、または他の GitHub 統合機能は無効になりません。既存のコメントは削除されません。

コメントは、CI 実行が 認証済み の場合にのみ投稿されます。
PR コミットではなく、例えば GitHub コメントなどでトリガーされるカスタムワークフローがある場合、GITHUB_REF 変数が refs/pull/<PR_NUMBER>/merge または refs/pull/<PR_NUMBER>/head に設定されていることを確認する必要があるかもしれません。
関連するコマンド(tuist share など)を、プレフィックス付きの GITHUB_REF 環境変数と一緒に実行できます: GITHUB_REF="refs/pull/${{ github.event.issue.number }}/head" tuist share
GitHub Actions ジョブサマリー#
Tuist CLI と Gradle プラグインは、テストとビルドの結果を GitHub Actions の ジョブサマリー に書き込みます。サマリーには Tuist 上の完全なレポートへのリンクがあり、不安定なテストやバンドルサイズの差分など、より豊富なインサイトを利用できます。
Gradle の場合、正常にアップロードされたビルドまたはテストレポートごとに独自のサマリーが追加され、gradle/actions/setup-gradle などのツールによって書き込まれた他のコンテンツが保持されます。これにはジョブサマリーサポートを含むプラグインバージョンが必要です。古い Gradle プラグインバージョンは、GitHub App の PR コメントを通じてのみレポートします。ジョブサマリーのために GitHub App を接続する必要はなく、Run report comments を無効にしても影響はありません。
GitHub Actions サマリーの宛先が利用可能な場合、Gradle は uploadInBackground が有効になっていても、終了前にアップロードとサマリーを待ちます。GitHub はワークフローステップが完了した時点でサマリーを取得します。

これは マージキュー と特に相性が良いです。マージキューの実行はプルリクエストに関連付けられないためコメントは投稿されませんが、ジョブサマリーには結果が表示されます。
ジョブサマリーには、レポートの正常なアップロードが必要です。ホスト型 Tuist サーバーでは、CI 実行が 認証済み である必要があります。セルフホスト型インスタンスでは、ネットワーク信頼レポート公開が有効になっている場合、認証情報なしのレポートも受け入れることができます。