コンテンツへスキップ

生成されたXcodeプロジェクト

Note

自動生成されたスキームには、tuist inspect build ポストアクションが自動的に含まれます。

生成されたスキームでビルドインサイトをトラックしたくない場合は、buildInsightsDisabled を使用して無効にしてください。

カスタムスキームを含む生成プロジェクトを使用している場合は、ポストアクションを自分で追加する必要があります。Mise の場合:

swift
let project = Project(
name: "MyProject",
targets: [
// Your targets
],
schemes: [
.scheme(
name: "MyApp",
shared: true,
buildAction: .buildAction(
targets: ["MyApp"],
postActions: [
.executionAction(
title: "Inspect Build",
scriptText: """
$HOME/.local/bin/mise x -C $SRCROOT -- tuist inspect build
""",
target: "MyApp"
)
],
runPostActionsOnFailure: true
),
runAction: .runAction(configuration: "Debug")
)
]
)

Miseを使用していない場合は、Xcodeのポストアクションがシェルの PATH を継承しないため、スキームの環境で tuist が利用可能であることを確認する必要があります。Homebrew インストールの場合:

swift
buildAction: .buildAction(
targets: ["MyApp"],
postActions: [
.executionAction(
title: "Inspect Build",
scriptText: """
export PATH="/opt/homebrew/bin:/usr/local/bin:$PATH"
tuist inspect build
""",
target: "MyApp"
)
],
runPostActionsOnFailure: true
)

CI でのビルドインサイト#

CI でビルドインサイトを追跡するには、CI が認証済みであることを確認してください。

Xcodebuild を使用した CI では、次のことが必要です:

  • xcodebuild アクションを呼び出す際は、tuist xcodebuild を使用してください。
  • xcodebuild コマンドに -resultBundlePath を追加してください。

-resultBundlePath がないと、必要なアクティビティログと結果バンドルが生成されず、tuist inspect build でビルドを分析できません。

プライベートネットワークでの認証不要なレポート#

セルフホスト環境では、開発者がサインインせずに完了したレポートを公開できます。オペレーターはインスタンスで TUIST_NETWORK_TRUSTED_INSIGHTS_ACCESS=true を設定し、セルフホスティングガイド に記載されている手順で再起動する必要があります。これはサポートされているすべてのプロジェクトに適用され、ダッシュボードの設定項目はありません。スキームのポストアクションやターミナルで使用される環境変数で、セルフホストURLとプロジェクトを設定してください。CLIは認証情報がない場合、自動的にインスタンスのポリシーを検出します:

bash
export TUIST_URL="https://tuist.internal.example"
tuist inspect build
# To publish local test results:
tuist inspect test

認証情報が実際に存在しない場合、アクティビティログとXCResultバンドルはローカルで解析され、構造化されたレポートとして送信されます。生のアーカイブ、添付ファイル、カバレッジ/履歴のアップロード、リモートプロセッサ、シャード参照、選択的実行の証拠は一切送信されません。レポートは引き続き表示可能ですが、認証されたテストケースの状態を更新したり、隔離/失敗の自動化をトリガーすることはできません。ダッシュボードやその他の特権コマンドには依然としてサインインが必要です。インスタンスが別途ネットワーク信頼キャッシュアクセスを有効にしているか、認証情報が用意されていない限り、キャッシュ統合は無効のままにしてください。

既存の認証情報は認証済み状態を維持します。無効、破損、空欄、または更新拒否された認証情報はフェイルクローズとなりディスク上に残るため、後続のコマンドが暗黙的に未署名状態になることはありません。回復措置として、再度サインインするか明示的にサインアウトしてください。認証不要クライアントをアップグレードする前に、すべてのサーバーレプリカをディスカバリー対応バージョンにアップグレードし、リダイレクトのない最終的なサーバーURLを設定してください。ディスカバリー機能のない古いサーバー、無効化されたインスタンス、およびディスカバリー失敗時は依然として認証が必要です。クライアント側のオプトインは不要です。TUIST_ACTOR_ID="" を個別に設定して構成済みのアクター要求を省略できます。検証済みの認証情報のIDには影響しません。

マシンメトリクス#

ビルドインサイトには、ビルド中に取得したマシンレベルのパフォーマンスメトリクス(CPU、メモリ、ネットワーク、ディスク使用量)を含めることができます。これを有効にするには、システムメトリクスを継続的にサンプリングする軽量なバックグラウンドデーモンを設定してください:

bash
tuist setup insights

これにより、バックグラウンドでメトリクスをサンプリングするローカルデーモンが実行されます。データは tuist inspect build によって自動的に収集され、ビルドレポートと一緒にアップロードされます。

ディスクメトリクスには読み書きアクティビティが含まれ、互換性のあるCLIとサーバーを使用している場合は、macOSのシステムDataボリューム(/System/Volumes/Data)の合計容量と利用可能容量も含まれます。利用可能容量にはパージ可能な領域は含まれません。ディスク容量チャートは、アップロード時だけでなく、ビルド全体の期間における使用済み容量(合計から利用可能を引いた値)と総容量を表示します。チェックアウトやDerivedDataに使用される個別の外部ボリュームは測定しません。

CLIをアップグレードした後、既存のサンプラーを tuist teardown insights で停止し、続いて tuist setup insights で再起動してください。サンプリングはビルド中に実行されている必要があります。古いレポートや失敗した測定にはディスク容量の値が含まれておらず、ゼロとして表示されることはありません。ディスク容量のサンプルは、既存の90日間のマシンメトリクス保持ポリシーに従います。

CI

CIマシンでもマシンメトリクスを取得するために、ビルド前に tuist setup insights を実行してください。

マシンメトリクスの収集を停止するには、次を実行してください:

bash
tuist teardown insights

これにより、デーモンのLaunchAgentがアンロードされ、plistが削除され、~/.local/state からサンプリングされたメトリクスとデーモンログが削除されるため、バックグラウンドで実行されているプロセスは残りません。

レポートアクタークレーム#

レポート作成リクエストには、TUIST_ACTOR_ID を組織スコープのラベル(例: TUIST_ACTOR_ID=employee-123 tuist inspect build)に明示的に設定した場合のみ、オプションの x-tuist-actor-id ヘッダーが含まれます。デフォルトではラベルは送信されず、Tuist はオペレーティングシステムのユーザー名を検出しません。TUIST_ACTOR_ID が空の場合、報告される識別子は省略されますが、認証情報ベースの検証済み ID は削除されません。識別子は、スペース以外の印刷可能 ASCII で 1〜128 バイトである必要があります。無効なオーバーライドは、フォールバックせずに省略されます。カスタムプロキシが不明なヘッダーを拒否する場合は、空の環境オーバーライドを使用してオプトアウトしてください。

検証済みの個別認証情報が優先されます。それ以外の場合、クライアントから報告された識別子は 未検証 と表示され、権限を付与したり、ユーザーに自動的にリンクしたりすることはありません。識別子は、プロジェクトのレポートを表示できるすべての人(プロジェクトが公開されている場合は公開ビューアーを含む)に表示され、データエクスポートにも含まれるため、機密情報を含めないでください。これは、ビルド、テスト、およびコマンドイベントのレポートに適用されます。古いサーバーはこのオプションのヘッダーを無視し、新しいサーバーはこのヘッダーなしで古いクライアントを受け入れます。識別子のない新しい共有トークンレポートは、公開組織ではなく 不明 と表示されます。履歴レポートは以前の帰属を保持します。ビルドおよびテストの一覧では、検証済みユーザーと未検証の報告識別子を区別します。セルフホストインスタンスが認証情報不要のレポートを明示的に有効にし、クライアントがそのポリシーを検出しない限り、認証は引き続き必要です。

スキームのポストアクション#

アクタークレームはデフォルトで無効になっています。スキームのポストアクション用に構成するには、シェルエクスポートに頼らず、そのスクリプト内で TUIST_ACTOR_ID を設定してください。Dock から起動した Xcode は、~/.zshrc の変数を継承しません。Homebrew で構成されたクレームを明示的に抑制するには、次を使用してください。

bash
export PATH="/opt/homebrew/bin:/usr/local/bin:$PATH"
export TUIST_ACTOR_ID=""
tuist inspect build

Mise を使用する場合、Mise が環境を読み込んだ後に値をオーバーライドします。

bash
$HOME/.local/bin/mise x -C "$SRCROOT" -- env TUIST_ACTOR_ID="" tuist inspect build

オプトインするには、空の値ではなく明示的なラベルを使用してください。

カスタムメタデータ#

環境変数を使用してビルドにメタデータを付与し、フィルタリングを改善できます。

環境変数#

変数 形式 説明
TUIST_BUILD_TAGS カンマ区切り 1 つの変数に複数のタグを設定します。
TUIST_BUILD_VALUE_* 単一値 サフィックスがキーとなるキーと値のペアです。

例#

ビルドを実行する前に、CI またはシェルでこれらの値を設定してください:

bash
export TUIST_BUILD_TAGS="nightly,ios-team,release-candidate"
bash
export TUIST_BUILD_VALUE_TICKET="PROJ-1234"
export TUIST_BUILD_VALUE_PR_URL="https://github.com/myorg/myrepo/pull/123"