Introducing Global Overridesの意訳です。
新しいレビューポリシーを展開するとしましょう。たとえば、すべてのSQLファイルに対する必須のパスインストラクションかもしれません。または、認証に関わるコードに対するより厳格なレビュープロファイルかもしれません。それらドキュメントに書き、Slackでメッセージを送り、オンボーディングに組み込みます。
3ヶ月後に確認してみると、半分のリポジトリには設定されていて、4分の1は独自のバージョンを持ち、残りは.coderabbit.yamlをこっそり変更してオプトアウトしていました。
すべての管理者がこの経験をしたことがあるでしょう。設定のずれはバグではなく、数十のチームがそれぞれ独自の設定ファイルを管理しているときに自然と起きることです。
Global Overridesとは
Global Overridesは、組織の管理者が組織内のすべてのリポジトリとすべてのPRレビューに対して設定を強制適用できる機能です。個々のリポジトリの.coderabbit.yamlやリポジトリレベルのUI設定、その他の場所に何が書かれていても関係ありません。
セットアップ方法
- CodeRabbit UIでOrganization Settingsを開きます
- サイドバー左下のモード切り替えでGlobal Overridesを選択します
.coderabbit.yamlと同じスキーマでYAMLを記述します — 強制適用したいキーのみを含めてください- 保存します
以上です。オーバーライドは、組織内のすべてのリポジトリで次のPRレビューから有効になります。
1点補足しておくと、YAML Editorとは異なり、Global Overridesのページではデフォルト値を含むすべての定義済み設定が表示されるため、何が強制適用されているかを一目で確認できます。オーバーライドが既存の設定と競合した場合
型に応じて、以下の3つの動作があります。
- オブジェクトはディープマージされます。オーバーライドのプロパティが、各ネストレベルで一致するプロパティを置き換えます。
- 配列はキーベースでマージされます。キーが一致する場合（例：
path_instructionsのpath）はオーバーライドのエントリが優先され、他のソースからの固有のエントリは保持されます。 - スカラー値は単純に上書きされます。
配列は3つの中で最も注意が必要です。Global Overridesは設定の継承と同じキーベースのマージを使用します。キーが一致する場合はオーバーライドのエントリが優先され、リポジトリが持つ固有のエントリはそのまま残ります。つまり、オーバーライドで短い配列を定義するだけではリポジトリの配列を完全にクリアすることはできません。エントリを置き換えたい場合は、オーバーライドのキーを一致させる必要があります。
利用できるユーザー
Global Overridesを表示・編集できるのは組織の管理者のみです。これがまさにこの機能の意図するところです。これは強制適用のメカニズムであり、共有デフォルトのメカニズムではありません。リポジトリがカスタマイズ可能な共有デフォルトが必要な場合は、代わりにcentral configurationを使用してください。
使うべきとき（と使うべきでないとき）
Global Overridesは、常にどこでも適用しなければならないポリシーのために作られています。例えば、以下のようなケースです。
- コンプライアンスに基づくレビュープロファイル
- 機密性の高いコード（SQL、認証、決済）に対する必須のパスインストラクション
- 無効にできない必須チェック
- 組織がどこでも確実に適用する必要があるセキュリティルール
一般的なデフォルト設定には向いていません。リポジトリが通常は持つべきだが、場合によっては逸脱してもよい設定であれば、Organization SettingsまたはCentral Configurationに入れてください。Global Overridesは、常に、どこでも、必ず適用しなければならないものに使ってください。
試してみましょう
組織の管理者であれば、Organization Settings — Global Overridesにアクセスして、これまで数ヶ月間適用しようとしてきたポリシーを設定してください。1分で完了します。次のPRレビューから反映されます。
