Bazel プロジェクト
Help me get started with Tuist. Follow the setup at:
https://tuist.dev/en/docs/guides/get-started/bazel-project
既存の Bazel ワークスペースを Tuist に接続するには、この手順に従ってください。Tuist は、Bazel がリモートキャッシュとして接続する Remote Execution API キャッシュと、すべてのビルドとテストをダッシュボード上の可視化データに変換する Build Event Service ストリームを提供します。Tuist が Bazel に追加する機能の概要については、Bazel with Tuist を参照してください。他の Bazel プロバイダーから移行する場合、変更点については BuildBuddy および EngFlow の比較ページで確認できます。
以下の各セクションでは、現在不足している機能を最初に示し、そのギャップを埋める機能の手順を説明します。
前提条件#
- Bazel ワークスペース(ルートに
WORKSPACEまたはMODULE.bazelがある)と、PATHに配置された Bazel。 - Tuist コマンドラインインターフェース。
ワークスペースを接続する#
Bazel ワークスペースのルートから tuist init を実行します。Tuist は WORKSPACE / MODULE.bazel を検出し、Bazel ワークスペースを統合 オプションを提供します。ブラウザで認証を行い、プロジェクトを所有すべきアカウントを選択してください。
tuist init
コーディングエージェントやスクリプトから実行する場合は、まず tuist auth login を実行し(ブラウザフローでは Enter キーを押すまで待機します)、その後、非インタラクティブな形式を使用します。
tuist init --build-system bazel --name <project-handle> --account <account>
init が完了すると、Tuist は以下を行います。
- プロジェクトハンドルを含む
tuist.tomlをワークスペースのルートに書き込みます。 .bazelrcの隣に.bazelrc.tuistを書き込み、最も近い Tuist キャッシュリージョンに接続し、ワークスペースごとのクレデンシャルヘルパーを通じて認証します。.bazelrcにtry-import %workspace%/.bazelrc.tuist行を追加します。
try-import 行をコミットします。これはすべてのマシンで同一です。.bazelrc.tuist を .gitignore に追加してください。クレデンシャルヘルパーのパスはユーザーごと、キャッシュリージョンは場所ごとに異なるため、共有しないでください。
ワークスペースが接続されると、以下のすべてが自動的に有効になります。
リモートキャッシュ#
Bazel のローカルディスクキャッシュは ~/.cache/bazel (または --disk_cache が指す場所)にあります。ある開発者のマシンでのキャッシュヒットは他の人には届かず、CI ジョブのコンテナは毎回空のキャッシュから開始されます。
Bazel の Remote Execution API は、同じキャッシュを共有エンドポイントに拡張するためのプロトコルです。Tuist はこれをサポートしています。.bazelrc.tuist が配置されると、Bazel は出力がすでに共有キャッシュにあるアクションをスキップし、代わりにダウンロードします。あるマシンでの作業は、同じリビジョンをビルドする他のすべてのマシンに恩恵をもたらします。
同じリビジョンに対して 2 回のクリーンビルドで検証します(ローカル、またはローカル 1 回 + CI 1 回)。
bazel clean
bazel build //...
2 回目の実行のサマリーにはキャッシュヒットが表示されるはずです。ダッシュボードの Cache を開いて、時間経過に伴うヒット率を確認してください。
ビルドとテストのインサイト#
Bazel のビルドイベントストリームとテストごとの XML レポートは、呼び出しごとに出力されます。1 週間 across ターゲットレベルの所要時間を比較したり、複数の CI 実行で不安定になったテストを発見したりするには、これらのイベントをどこかで収集・集計する必要があります。
Bazel がすでに出力している Build Event Service プロトコルは、まさにそのために設計されています。tuist init が書き込んだ .bazelrc.tuist は、BES ストリームを Tuist 向けに構成するため、次の bazel build と bazel test でビルドおよびテストのインサイトの流れが始まります。追加の設定は不要です。ダッシュボードの Builds と Tests を開いてデータを確認してください。
チームを巻き込む#
キャッシュヒットとインサイトは、プロジェクトに接続されている人数に応じて増幅されます。ダッシュボードのアカウント設定からチームメイトを組織に招待し、Single Sign-On(Google、Okta、Microsoft)を設定して、オンボーディングを個人ごとの tuist auth login ではなくクリックだけで完了できるようにしてください。