Bazel Starlark ルールは、次の 2 つのシナリオで Bazel LTS リリースとの互換性を損なう可能性があります。
- このルールは、依存する機能が HEAD の Bazel から削除されているため、今後の LTS リリースとの互換性を破ります。
- このルールは、依存する機能が新しい Bazel LTS リリースでのみ使用できるため、現在の LTS リリースまたはそれ以前の LTS リリースとの互換性を破ります。
一方、ルール自体がユーザーにとって互換性のない変更を送信することもあります。Bazel の破壊的変更と組み合わせると、ルールのバージョンと Bazel のバージョンをアップグレードすることが、Bazel ユーザーの不満の原因になることがあります。このページでは、ユーザーが Bazel とルールを簡単にアップグレードできるように、ルール作成者が Bazel とのルールの互換性を維持する方法について説明します。
管理可能な移行プロセス
すべてのバージョンの Bazel とすべてのバージョンのルールとの互換性を保証することは明らかに現実的ではありませんが、Google は、Bazel ユーザーが移行プロセスを管理できるようにすることを目標としています。管理可能な移行プロセスとは、ユーザーがルールのメジャー バージョンと Bazel のメジャー バージョンを同時にアップグレードする必要がないプロセスであり、これにより、ユーザーは 1 つのソースからの互換性のない変更を一度に処理できます。
たとえば、次の互換性マトリックスを使用します。
- rules_foo 1.x + Bazel 4.x から rules_foo 2.x + Bazel 5.x への移行は、ユーザーが rules_foo と Bazel のメジャー バージョンを同時にアップグレードする必要があるため、管理可能とは見なされません。
- rules_foo 2.x + Bazel 5.x から rules_foo 3.x + Bazel 6.x への移行は、ユーザーが Bazel のメジャー バージョンを変更せずに、まず rules_foo を 2.x から 3.x にアップグレードしてから、Bazel を 5.x から 6.x にアップグレードできるため、管理可能と見なされます。
| rules_foo 1.x | rules_foo 2.x | rules_foo 3.x | HEAD | |
|---|---|---|---|---|
| Bazel 4.x | ✅ | ❌ | ❌ | ❌ |
| Bazel 5.x | ❌ | ✅ | ✅ | ❌ |
| Bazel 6.x | ❌ | ❌ | ✅ | ✅ |
| HEAD | ❌ | ❌ | ❌ | ✅ |
❌: どのメジャー ルール バージョンも Bazel LTS リリースと互換性がありません。
✅: 少なくとも 1 つのバージョンのルールが、最新バージョンの Bazel LTS リリースと互換性があります。
ベスト プラクティス
Bazel ルールの作成者は、次のベスト プラクティスに従うことで、ユーザーにとって管理可能な移行プロセスを確保できます。
- このルールはセマンティック バージョニングに従う必要があります。同じメジャー バージョンのマイナー バージョンには下位互換性があります。
- HEAD のルールは、最新の Bazel LTS リリースと互換性がある必要があります。
- HEAD のルールは、HEAD の Bazel と互換性がある必要があります。これを実現するには、次の手順を行います。
- Bazel で HEAD で独自の CI テストを設定する
- プロジェクトを Bazel ダウンストリーム テストに追加します。Bazel の破壊的変更がプロジェクトに影響する場合、Bazel チームはプロジェクトに問題を報告します。問題にタイムリーに対応するには、ダウンストリーム プロジェクト ポリシーに準拠する必要があります。
- ルールの最新のメジャー バージョンは、最新の Bazel LTS リリースと互換性がある必要があります。
- ルールの新しいメジャー バージョンは、ルールの以前のメジャー バージョンでサポートされている最後の Bazel LTS リリースと互換性がある必要があります。
2. と 3. を達成することが最も重要なタスクです。これにより、4. と 5. を達成できます。自然に。
HEAD の Bazel と最新の Bazel LTS リリースの両方との互換性を維持しやすくするために、ルール作成者は次のことができます。
- 最新の LTS リリースに下位互換性のある機能をバックポートするようリクエストするには、リリース プロセスをご覧ください。
- bazel_features を使用して Bazel の特徴検出を行います。
一般に、推奨されるアプローチでは、最新の Bazel LTS リリースとの互換性を失うことなく、Bazel との互換性のない変更に対してルールを移行し、HEAD で新しい Bazel 機能を使用できます。