Bazel メンテナンス担当者向けガイド

これは、Bazel オープンソース プロジェクトのメンテナー向けのガイドです。

Bazel への貢献をお考えの場合は、代わりに Contributing to Bazel をご覧ください。

このページの目的は次のとおりです。

  1. プロジェクトのコントリビューション プロセスのメンテナーの信頼できる情報源として機能する。
  2. コミュニティのコントリビューターとプロジェクトのメンテナーの間で期待値を設定する。

Bazel の コア コントリビューター グループには、オープンソース プロジェクトのさまざまな側面を管理するための専用の サブチームがあります。それらは以下のとおりです。

  • リリース プロセス: Bazel のリリース プロセスを管理します。
  • グリーン チーム: ルールとツールの健全なエコシステムを育成します。
  • デベロッパー エクスペリエンス ガーデナー: 外部からのコントリビューションを促進し、 問題と pull リクエストを確認して、開発ワークフローをよりオープンにします。

リリース

継続的インテグレーション

bazelbuild/continuous-integration リポジトリで、Bazel の継続的インテグレーション インフラストラクチャに関するグリーン チームのガイドをご覧ください。

問題のライフサイクル

  1. ユーザーが 問題テンプレートのいずれかを選択して問題を作成すると、 未審査のオープンな 問題のプールに追加されます。
  2. デベロッパー エクスペリエンス(DevEx)サブチームのローテーションのメンバーが問題を確認します。
    1. 問題がバグ機能リクエストでない場合、通常、DevEx メンバーは問題をクローズし、質問の可視性を高めるためにユーザーを StackOverflowbazel-discussにリダイレクトします。
    2. rules_apple
    3. 問題が曖昧な場合や情報が不足している場合、DevEx メンバーは問題をユーザーに割り当てて、続行する前に詳細情報をリクエストします。これは通常、ユーザーが適切な 問題テンプレート {: .external} を選択していない場合や、情報が不完全な場合に発生します。
  3. 問題を確認した後、DevEx メンバーは問題に早急な対応が必要かどうかを判断します。必要な場合は、P0 優先度ラベルと、チームリーダーのリストからオーナーを割り当てます。
  4. DevEx メンバーは、ルーティング用に untriaged ラベルと 1 つの チーム ラベルを割り当てます。
  5. また、DevEx メンバーは、問題のタイプに応じて、type: bugtype: feature request などの type: ラベルを 1 つだけ割り当てます。
  6. プラットフォーム固有の問題の場合、DevEx メンバーは platform: ラベルを 1 つ割り当てます。 たとえば、Mac 固有の問題の場合は platform:apple です。
  7. 問題の優先度が低く、新しいコミュニティ コントリビューターが対応できる場合は、DevEx メンバーが good first issue ラベルを割り当てます。 この段階で、問題は未トリアージのオープンな 問題のプールに追加されます。

各 Bazel サブチームは、所有するラベルのすべての問題をトリアージする必要があります。できれば週に 1 回行うことをおすすめします。サブチームは問題を確認して評価し、可能であれば解決策を提供します。チームラベルのオーナーの場合は、こちらのセクション で詳細をご確認ください。

問題が解決したら、クローズできます。

pull リクエストのライフサイクル

  1. ユーザーが pull リクエストを作成します。
  2. Bazel チームのメンバーで、自分の領域に対して PR を送信する場合は、チームラベルを割り当てて最適なレビュー担当者を見つける必要があります。
  3. それ以外の場合は、毎日のトリアージ中に、DevEx メンバーがルーティング用に 1 つの チームラベルとチームのテクニカル リード(TL)を割り当てます。
    1. TL は、PR のレビュー担当者を任意で割り当てることができます。
  4. 割り当てられたレビュー担当者は PR を確認し、承認または破棄されるまで作成者と協力します。
  5. 承認された場合、レビュー担当者は PR の commit を Google の内部バージョン管理システムにインポート して、さらにテストを行います。Bazel は Google 社内で使用されているものと同じビルドシステムであるため、内部テストスイートに対してすべての PR commit をテストする必要があります。これが、PR を直接マージしない理由です。
  6. インポートされた commit がすべての内部テストに合格すると、commit はスクワッシュされ、GitHub にエクスポートされます。
  7. commit がマスターにマージされると、GitHub は PR を自動的にクローズします。

私のチームがラベルを所有しています。どうすればよいですか?

サブチームは、所有するラベルのすべての問題をトリアージする必要があります。 できれば週に 1 回行うことをおすすめします。

問題

  1. チームラベル untriaged ラベルで問題のリストをフィルタします。
  2. 問題を確認します。
  3. 優先度を特定してラベルを割り当てます。
    1. P0 の場合、DevEx サブチームによって優先度がすでに設定されている可能性があります。必要に応じて優先度を再設定してください。
    2. 各問題には、優先度ラベルが 1 つだけ必要です。問題が P0 または P1 の場合は、対応中であると想定されます。
  4. untriaged ラベルを削除します。

ラベルを追加または削除するには、bazelbuild organization に属している必要があります。

pull リクエスト

  1. チームラベルで pull リクエストのリストをフィルタします。
  2. オープンな pull リクエストを確認します。
    1. 省略可: レビュー担当者に割り当てられているが、適切でない場合は、コードレビューを行う適切なレビュー担当者を再割り当てします。
  3. pull リクエストの作成者と協力してコードレビューを完了します。
  4. PR を承認します。
  5. すべてのテストに合格していることを確認します。
  6. パッチを内部バージョン管理システムにインポートし、内部 presubmit を実行します。
  7. 内部パッチを送信します。パッチが正常に送信されてエクスポートされると、GitHub によって PR が自動的にクローズされます。

候補

メンテナーは、次の優先度の定義を使用して問題をトリアージします。

  • P0 - Bazel リリース(リリース候補を除く)が使用できなくなる重大な機能の破損、または Bazel プロジェクトの開発に重大な影響を与えるサービス停止。これには、多数のユーザーをブロックする新しいリリースで導入された回帰や、 破壊的変更ポリシーに準拠していない互換性のない破壊的変更が含まれます。実用的な回避策はありません。
  • P1 - 次のリリースで対応する必要がある重大な欠陥または 機能、または多くのユーザー(Bazel プロジェクトの開発を含む)に影響を与える重大な問題ですが、 実用的な回避策があります。通常、早急な対応は必要ありません。需要が高く、現在の四半期のロードマップで計画されています。
  • P2 - 対応する必要がある欠陥または機能 ですが、現在対応していません。リリースされた Bazel バージョンで、ユーザーにとって不便な中程度の配信時の問題。今後のリリースで対応する必要があるか、簡単な回避策が存在します。
  • P3 - 影響の小さい望ましいマイナー バグ 修正または機能強化。Bazel のロードマップや今後のリリースでは優先されませんが、コミュニティからのコントリビューションは歓迎します。
  • P4 - 優先度の低い欠陥 またはクローズされる可能性の低い機能リクエスト。より多くのユーザーに影響する場合は、優先度を再設定するためにオープンにしておくこともできます。

チームラベル

  • team-Android: Android チームの問題
  • team-Bazel: Bazel の一般的なプロダクト/戦略に関する問題
  • team-CLI: コンソール UI
  • team-Configurability: 構成可能性チームの問題。含まれるもの: コアビルド構成と移行システム。含まれないもの: 新しいフラグまたは既存のフラグの変更
  • team-Core: Skyframe、bazel query、BEP、オプションの解析、bazelrc
  • team-Documentation: ドキュメント チームの問題
  • team-ExternalDeps: 外部依存関係の処理、Bzlmod、リモート リポジトリ、WORKSPACE ファイル
  • team-Loading-API: BUILD ファイルとマクロ処理: ラベル、package()、visibility、glob
  • team-Local-Exec: 実行(ローカル)チームの問題
  • team-OSS: Bazel OSS チームの問題: インストール、リリース プロセス、Bazel パッケージ、ウェブサイト、ドキュメント インフラストラクチャ
  • team-Performance: Bazel パフォーマンス チームの問題
  • team-Remote-Exec: 実行(リモート)チームの問題
  • team-Rules-API: ルール/アスペクトの作成用 API: プロバイダ、runfiles、アクション、アーティファクト
  • team-Rules-CPP / team-Rules-ObjC: ネイティブ Apple ルールロジックを含む、C++/Objective-C ルールの問題
  • team-Rules-Java: Java ルールの問題
  • team-Rules-Python: ネイティブ Python ルールの問題
  • team-Rules-Server: Bazel に含まれるサーバーサイド ルールの問題
  • team-Starlark-Integration: API 以外の Bazel + Starlark 統合。含まれるもの: Bazel が Starlark インタープリタをトリガーする方法、Stardoc、組み込みの挿入、文字エンコード。 含まれないもの: BUILD 言語または .bzl 言語の問題。
  • team-Starlark-Interpreter: Starlark インタープリタの問題(java.net.starlark のすべて)。BUILD API と .bzl API の問題(Bazel と Starlark の統合を表す)は team-Build-Language にあります。

新しい問題については、category: * ラベルは非推奨となり、チームラベルが推奨されています。

ラベルの完全なリストはこちらをご覧ください。