本頁面適用對象為 Bazel 規則存放區的擁有者和維護者。說明如何為存放區設定 Bazel 持續整合 (CI) 系統,以便測試規則與遠端執行情境的相容性。本頁的操作說明適用於儲存在 GitHub 存放區中的專案。
必要條件
完成本頁中的步驟前,請確認下列事項:
- 您的 GitHub 存放區是 Bazel GitHub 機構的一部分。
- 您已按照 Bazel 持續整合的說明設定存放區的 Buildkite。
設定用於測試的 Bazel CI
在您的
.bazelci/presubmit.yml
檔案中,執行下列操作:a. 新增名為
rbe_ubuntu1604
的設定。b. 在
rbe_ubuntu1604
設定中,新增要用於遠端執行測試的建構和測試目標。將
bazel-toolchains
GitHub 存放區新增至WORKSPACE
檔案,並固定在最新版本中。此外,請新增名為buildkite_config
的rbe_autoconfig
目標。本例會使用rbe_ubuntu1604
的 BuildKite CI 建立工具鍊設定,以便進行遠端執行。
load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
rbe_autoconfig(name = "buildkite_config")
傳送包含您變更的提取要求至
presubmit.yml
檔案。(請參閱提取要求範例)。如要查看建構結果,請在 GitHub 中,按一下 RBE (Ubuntu 16.04) 提取要求檢查的「Details」(詳細資料),如下圖所示。提取要求合併且持續整合測試執行後,這個連結就會生效。(請參閱結果範例)。
(選用) 將 bazel test (RBE (Ubuntu 16.04)) 檢查當做在合併分支版本保護規則之前必須通過的測試。這項設定位於 GitHub 的「Settings」>「Branches」>「Branch Protection rules」,如下圖所示。
排解建構和測試失敗的問題
如果建構或測試失敗,可能的原因如下:
預設容器中未安裝必要的建構或測試工具。根據預設,使用
rbe_ubuntu1604
設定的建構作業會在rbe-ubuntu16-04
容器內執行,其中包含許多 Bazel 建構作業常用的工具。不過,如果您的規則需要預設容器中沒有的工具,就必須根據rbe-ubuntu16-04
容器建立自訂容器並按下方說明加入這些工具。建構或測試目標使用與遠端執行不相容的規則。如要進一步瞭解與遠端執行作業的相容性,請參閱針對遠端執行調整 Bazel 規則。
在 rbe_ubuntu1604 CI 設定中使用自訂容器
rbe-ubuntu16-04
容器可公開於下列網址存取:
http://gcr.io/cloud-marketplace/google/rbe-ubuntu16-04
您可以直接從 Container Registry 提取,或是從原始碼建構。以下各節將說明這兩種選項。
開始之前,請確認已安裝 gcloud
、docker
和 git
。
如果您要從原始碼建構容器,也必須安裝最新版本的 Bazel。
從 Container Registry 提取 rbe-ubuntu16-04
如要從 Container Registry 提取 rbe-ubuntu16-04
容器,請執行下列指令:
gcloud docker -- pull gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
將 sha256-checksum 替換為最新容器的 SHA256 總和檢查碼值。
從原始碼建構 rbe-ubuntu16-04 容器
如要從原始碼建構 rbe-ubuntu16-04
容器,請按照下列步驟操作:
複製
bazel-toolchains
存放區:git clone https://github.com/bazelbuild/bazel-toolchains
按照工具鍊容器的說明設定工具鍊容器目標並建構容器。
提取剛剛建構的容器:
gcloud docker -- pull gcr.io/project-id/custom-container-namesha256-checksum
執行自訂容器
如要執行自訂容器,請執行下列其中一項操作:
如果您已從 Container Registry 提取容器,請執行下列指令:
docker run -it gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum/bin/bash
將
sha256-checksum
替換為最新容器的 SHA256 總和檢查碼值。如果您是從原始碼建構容器,請執行下列指令:
docker run -it gcr.io/project-id/custom-container-name@sha256:sha256sum /bin/bash
在自訂容器中新增資源
使用 Dockerfile
或 rules_docker
將原始資源的資源或替代版本新增至 rbe-ubuntu16-04
容器。如果您是 Docker 新手,請閱讀以下內容:
舉例來說,下列 Dockerfile
程式碼片段會安裝 my_tool_package
:
FROM gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
RUN apt-get update && yes | apt-get install -y my_tool_package
將自訂容器推送至 Container Registry
自訂容器後,建構容器映像檔並推送至 Container Registry,如下所示:
建構容器映像檔:
docker build -t custom-container-name.
docker tag custom-container-name gcr.io/project-id/custom-container-name
將容器映像檔推送到 Container Registry:
gcloud docker -- push gcr.io/project-id/custom-container-name
請前往下列網址,確認容器是否已推送:
https://console.cloud.google.com/gcr/images/project-id/GLOBAL/custom-container-name
請記下自訂容器的 SHA256 總和檢查碼。稍後您需要在建構平台定義中提供這項資訊。
按照公開提供映像檔一節的說明,將容器設定成可公開存取。
詳情請參閱推送及提取映像檔。
指定建構平台定義
您必須在自訂工具鍊設定中加入 Bazel 平台設定,以便 Bazel 選擇適合所需硬體/軟體平台的工具鍊。如要自動產生有效的平台,您可以將名稱設為 buildkite_config
的 rbe_autoconfig
目標新增至 WORKSPACE
,其中包含用於選取自訂容器的其他屬性。如要進一步瞭解這項設定,請參閱 rbe_autoconfig
的最新說明文件。